sentdm 0.44.0 → 0.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46c6f38c1bac617a9d4b5f114cf1315c0165581995884399707a19b74db1d1c7
-  data.tar.gz: 9fd166f6b0d86b2fe8bba638891c98bcf80f77bbdd6a035aa9524ec5a666c239
+  metadata.gz: 819f750414001d5ce375dfda603f82bdf86ac538321ad3c9a507211cbf03e961
+  data.tar.gz: 438e1fa1e2c0dc0566f22a96af84026c640db01e4605635e3156fdfd81c6a0b7
 SHA512:
-  metadata.gz: e313815b9a52feac9bf9cc74368eec76805d90c4d4e83bdf01866e7ba837745fd8bb089b901ae602c3aec9041994aef97b66a74dae712ef5586b774f120eeb59
-  data.tar.gz: 473e10edb48f2d5c5c46df341966ca4db2bab6b024eb7e57369a474f816f8fa1490534287c58d3917d0a6c14b01a017ad329601d8ce0e052732ccfb5892ab953
+  metadata.gz: 31802c8938ba238bae598ec3c37fd21103d8627752dc936f503c33ada9ba8bc7580840db2bb6572b04badc9da775a45eec55820b5b1e675dc20a3b54cfbce6e5
+  data.tar.gz: 5a9d28dcae2395c7f925a04dd8dc825d0ca2c17df646ade6304a31fd0679ee136af4ff0f01270762cc82d2ab08e3d6b5e5b1beeed3f148576480fffc70bac936

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.46.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.45.0...v0.46.0) (2026-11-06)
+
+
+### ⚠ BREAKING CHANGES
+
+* **api:** stable names for shared models; typed methods for sender profiles, channels, compliance requirements and message cancel
+
+### Features
+
+* **api:** stable names for shared models; typed methods for sender profiles, channels, compliance requirements and message cancel ([7cb0e2c](https://github.com/sentdm/sent-dm-ruby/commit/7cb0e2c11b4dce51a7832d4ae4352224957f0224))
+
+## [0.45.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.44.0...v0.45.0) (2026-11-05)
+
+
+### Features
+
+* **api:** sync OpenAPI spec from production ([850cfec](https://github.com/sentdm/sent-dm-ruby/commit/850cfec93cf24d63cc4be16f61a61b14587fe7cc))
+
 ## [0.44.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.43.0...v0.44.0) (2026-11-04)
 
 

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "sentdm", "~> 0.44.0"
+gem "sentdm", "~> 0.46.0"
 ```
 
 <!-- x-release-please-end -->
@@ -248,7 +248,7 @@ You can provide typesafe request parameters like so:
 ```ruby
 sent.messages.send_(
   channel: ["sms", "whatsapp"],
-  template: Sentdm::MessageSendParams::Template.new(
+  template: Sentdm::TemplateRef.new(
     id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
     name: "order_confirmation",
     parameters: {name: "John Doe", order_id: "12345"}
@@ -274,7 +274,7 @@ sent.messages.send_(
 # You can also splat a full Params class:
 params = Sentdm::MessageSendParams.new(
   channel: ["sms", "whatsapp"],
-  template: Sentdm::MessageSendParams::Template.new(
+  template: Sentdm::TemplateRef.new(
     id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
     name: "order_confirmation",
     parameters: {name: "John Doe", order_id: "12345"}
@@ -289,25 +289,25 @@ sent.messages.send_(**params)
 Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
 
 ```ruby
-# :ACTIVE
-puts(Sentdm::Channels::VoiceUpdateParams::Status::ACTIVE)
+# :LOCAL
+puts(Sentdm::Channels::SMSCreateParams::NumberType::LOCAL)
 
-# Revealed type: `T.all(Sentdm::Channels::VoiceUpdateParams::Status, Symbol)`
-T.reveal_type(Sentdm::Channels::VoiceUpdateParams::Status::ACTIVE)
+# Revealed type: `T.all(Sentdm::Channels::SMSCreateParams::NumberType, Symbol)`
+T.reveal_type(Sentdm::Channels::SMSCreateParams::NumberType::LOCAL)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
 # Using the enum constants preserves the tagged type information:
-sent.channels.voice.update(
-  status: Sentdm::Channels::VoiceUpdateParams::Status::ACTIVE,
+sent.channels.sms.create(
+  number_type: Sentdm::Channels::SMSCreateParams::NumberType::LOCAL,
   # …
 )
 
 # Literal values are also permissible:
-sent.channels.voice.update(
-  status: :ACTIVE,
+sent.channels.sms.create(
+  number_type: :LOCAL,
   # …
 )
 ```

data/lib/sentdm/client.rb

@@ -63,6 +63,26 @@ module Sentdm
     # @return [Sentdm::Resources::Profiles]
     attr_reader :profiles
 
+    # Your customers, each sending as itself.
+    #
+    # A sender profile is a tenant of yours: it has its own API key, its own balance,
+    # and can have its own identity and senders — so your customers send under their
+    # own brand and never see Sent. Depth is one; a profile cannot create profiles.
+    #
+    # **Everything is inherited unless the profile owns it.** `{ "name": "…" }` alone
+    # gives you a usable profile immediately, running on your identity, your inbox and
+    # your billing. Supply a capability's fields and the profile owns that one
+    # instead.
+    #
+    # **A sender is the exception.** A brand and a campaign can be inherited; a number
+    # cannot. A profile either has a sender of its own or terminates through your
+    # shared routes.
+    #
+    # To act for a profile on any other resource, send `x-profile-id` with your
+    # organization key rather than looking for a parallel set of endpoints.
+    # @return [Sentdm::Resources::SenderProfiles]
+    attr_reader :sender_profiles
+
     # What a phone number actually is, before you send to it.
     #
     # A lookup returns the number's country, line type and carrier, which is what
@@ -123,9 +143,53 @@ module Sentdm
     # @return [Sentdm::Resources::Voice]
     attr_reader :voice
 
+    # The senders you send from, one per channel.
+    #
+    # **SMS is a list of markets**, each keyed by `(country, number_type)` — a
+    # customer can hold `us/10dlc` and `gb/alphanumeric` at once, so a market is
+    # addressed by the pair rather than by country alone. **WhatsApp and RCS are
+    # single**: a customer has one business account and one agent. **Voice is per
+    # number**: each number you hold can carry phone calls on its own
+    # (`POST /v3/channels/voice`), each with the callback URL Sent asks what to do
+    # with its calls, one of them is the default line for calls placed from your app,
+    # and voice tokens are minted with `POST /v3/voice/tokens`. Read your voice
+    # numbers with `GET /v3/channels/voice` and change one with
+    # `PATCH /v3/channels/voice/{number}`.
+    #
+    # ## Compliance lives on the market
+    #
+    # Adding a market records everything that market registers with, in its
+    # `compliance` object. Only **US `TEN_DLC`** registers with a regime — The
+    # Campaign Registry — and it is the only market whose compliance carries `brand`
+    # and `campaign`. Everywhere else compliance is documents, and many markets ask
+    # for none at all.
+    #
+    # `GET` and `PATCH` on a market return and accept the same shape, so what comes
+    # back can be sent back: an omitted key is left alone, and a key reported in
+    # `requirements` is the path into the body that clears it.
+    #
+    # Call `GET /v3/compliance/requirements` first — it answers what a market demands
+    # before you hold it, with a body you can fill in and post.
     # @return [Sentdm::Resources::Channels]
     attr_reader :channels
 
+    # What a market demands, before you have it.
+    #
+    # Requirements vary enormously and change without notice. US `TEN_DLC` registers a
+    # brand and a campaign with The Campaign Registry and asks a substantial set of
+    # questions; an alphanumeric sender pre-registers with documents in one country
+    # and needs nothing in another.
+    #
+    # This is the authoritative answer for whichever market you ask about, and it is
+    # generated from the same declaration that validates the calls themselves — so it
+    # cannot drift from what is actually enforced. The response includes the request
+    # body to send, with every key that market wants already present and blank.
+    #
+    # What you supplied, as opposed to what is asked of you, is reported on the market
+    # under **Channels**.
+    # @return [Sentdm::Resources::Compliance]
+    attr_reader :compliance
+
     # Who the current key is.
     #
     # `GET /v3/me` answers with the account the key authenticates as, which is the
@@ -200,12 +264,14 @@ module Sentdm
       @users = Sentdm::Resources::Users.new(client: self)
       @templates = Sentdm::Resources::Templates.new(client: self)
       @profiles = Sentdm::Resources::Profiles.new(client: self)
+      @sender_profiles = Sentdm::Resources::SenderProfiles.new(client: self)
       @numbers = Sentdm::Resources::Numbers.new(client: self)
       @messages = Sentdm::Resources::Messages.new(client: self)
       @contacts = Sentdm::Resources::Contacts.new(client: self)
       @conversations = Sentdm::Resources::Conversations.new(client: self)
       @voice = Sentdm::Resources::Voice.new(client: self)
       @channels = Sentdm::Resources::Channels.new(client: self)
+      @compliance = Sentdm::Resources::Compliance.new(client: self)
       @me = Sentdm::Resources::Me.new(client: self)
     end
   end

data/lib/sentdm/internal/sender_profiles_page.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if sender_profiles_page.has_next?
+    #     sender_profiles_page = sender_profiles_page.next_page
+    #   end
+    #
+    # @example
+    #   sender_profiles_page.auto_paging_each do |sender_profile|
+    #     puts(sender_profile)
+    #   end
+    class SenderProfilesPage
+      include Sentdm::Internal::Type::BasePage
+
+      # @return [Data]
+      attr_accessor :data
+
+      # @return [Boolean]
+      def next_page?
+        data&.pagination&.has_more
+      end
+
+      # @raise [Sentdm::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Sentdm::Internal::Util.deep_merge(
+          @req,
+          {query: {page: @req.fetch(:query).fetch(:page, 1).to_i.succ}}
+        )
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.data&.sender_profiles&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [Sentdm::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {data: Hash | nil => data}
+          if (sender_profiles = data[:sender_profiles]).is_a?(Array)
+            data =
+              {**data, sender_profiles: sender_profiles.map { Sentdm::Internal::Type::Converter.coerce(@model, _1) }}
+          end
+          @data = Sentdm::Internal::Type::Converter.coerce(Sentdm::Internal::SenderProfilesPage::Data, data)
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = Sentdm::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute pagination
+        #
+        #   @return [Data::Pagination, nil]
+        optional :pagination, -> { Data::Pagination }
+
+        # @!attribute sender_profiles
+        #
+        #   @return [Array<Object>, nil]
+        optional :sender_profiles, Sentdm::Internal::Type::ArrayOf[Sentdm::Internal::Type::Unknown]
+
+        # @!method initialize(pagination: nil, sender_profiles: nil)
+        #   @param pagination [Data::Pagination]
+        #   @param sender_profiles [Array<Object>]
+
+        # @see Data#pagination
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          # @!attribute has_more
+          #
+          #   @return [Boolean, nil]
+          optional :has_more, Sentdm::Internal::Type::Boolean
+
+          # @!attribute page
+          #
+          #   @return [Integer, nil]
+          optional :page, Integer
+
+          # @!attribute page_size
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
+          # @!attribute total_count
+          #
+          #   @return [Integer, nil]
+          optional :total_count, Integer
+
+          # @!attribute total_pages
+          #
+          #   @return [Integer, nil]
+          optional :total_pages, Integer
+
+          # @!method initialize(has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
+          #   @param has_more [Boolean]
+          #   @param page [Integer]
+          #   @param page_size [Integer]
+          #   @param total_count [Integer]
+          #   @param total_pages [Integer]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/internal/type/enum.rb

@@ -17,28 +17,28 @@ module Sentdm
       # values safely.
       #
       # @example
-      #   # `tcr_brand_relationship` is a `Sentdm::TcrBrandRelationship`
-      #   case tcr_brand_relationship
-      #   when Sentdm::TcrBrandRelationship::BASIC_ACCOUNT
+      #   # `entity_type` is a `Sentdm::EntityType`
+      #   case entity_type
+      #   when Sentdm::EntityType::PRIVATE_PROFIT
       #     # ...
-      #   when Sentdm::TcrBrandRelationship::MEDIUM_ACCOUNT
+      #   when Sentdm::EntityType::PUBLIC_PROFIT
       #     # ...
-      #   when Sentdm::TcrBrandRelationship::LARGE_ACCOUNT
+      #   when Sentdm::EntityType::NON_PROFIT
       #     # ...
       #   else
-      #     puts(tcr_brand_relationship)
+      #     puts(entity_type)
       #   end
       #
       # @example
-      #   case tcr_brand_relationship
-      #   in :BASIC_ACCOUNT
+      #   case entity_type
+      #   in :PRIVATE_PROFIT
       #     # ...
-      #   in :MEDIUM_ACCOUNT
+      #   in :PUBLIC_PROFIT
       #     # ...
-      #   in :LARGE_ACCOUNT
+      #   in :NON_PROFIT
       #     # ...
       #   else
-      #     puts(tcr_brand_relationship)
+      #     puts(entity_type)
       #   end
       module Enum
         include Sentdm::Internal::Type::Converter

data/lib/sentdm/models/account.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class Account < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #   Customer ID (organization, account, or profile)
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute channels
+      #   Messaging channel configuration. All three channels are always present. Each
+      #   channel has a "configured" flag; configured channels expose additional details.
+      #
+      #   @return [Sentdm::Models::AccountChannels, nil]
+      optional :channels, -> { Sentdm::AccountChannels }
+
+      # @!attribute created_at
+      #   When the account was created
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute description
+      #   Account description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute email
+      #   Contact email address
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute enable_template_auto_creation_for_sp
+      #   Whether this account may mark a template for automatic creation on its sender
+      #   profiles. Granted by Sent per account and off by default, so it is what a
+      #   template-create form reads to decide whether to offer the option at all —
+      #   marking a template without it does nothing.
+      #
+      #   Top-level rather than inside settings, which is written for type: "profile" only
+      #   and so would never carry it to the account type that can act on it.
+      #
+      #   This is the capability, not the stored flag: a profile reports false whatever
+      #   its own row holds. A sender profile owns no sender profiles, so a template it
+      #   marked would have nothing to be created on and the fan-out would never read the
+      #   flag. The admin GET /customers/{id} reports the stored value instead, because
+      #   that is the one an operator granted.
+      #
+      #   @return [Boolean, nil]
+      optional :enable_template_auto_creation_for_sp, Sentdm::Internal::Type::Boolean
+
+      # @!attribute icon
+      #   Account icon URL
+      #
+      #   @return [String, nil]
+      optional :icon, String, nil?: true
+
+      # @!attribute name
+      #   Account name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute organization_id
+      #   Organization ID (only for profile type — the parent organization)
+      #
+      #   @return [String, nil]
+      optional :organization_id, String, nil?: true
+
+      # @!attribute profiles
+      #   List of profiles (populated for organization type, empty for user and profile
+      #   types)
+      #
+      #   @return [Array<Sentdm::Models::AccountProfile>, nil]
+      optional :profiles, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::AccountProfile] }
+
+      # @!attribute sending_phone_number
+      #   The SMS sender this account sends from in the United States, in E.164 form. Null
+      #   when the account has no US SMS sender.
+      #
+      #   The same value as channels.sms.phone_number, published under both names on
+      #   purpose: sending_phone_number is what this value is already called on GET
+      #   /v3/profiles, so the same key answers the same question whichever of the two
+      #   endpoints you ask. Neither name is preferred over the other and neither is
+      #   deprecated.
+      #
+      #   The same value, not the same presence: this key is always written, including as
+      #   null, whereas channels.sms.phone_number is left out entirely when there is no
+      #   sender.
+      #
+      #   @return [String, nil]
+      optional :sending_phone_number, String, nil?: true
+
+      # @!attribute sending_phone_number_profile_id
+      #   The account that holds sending_phone_number in number inventory: normally this
+      #   account itself, and a different account when the number is held elsewhere. Null
+      #   when there is no US sender, or when the sender is not a number drawn from
+      #   inventory — an alphanumeric sender ID or a short code.
+      #
+      #   @return [String, nil]
+      optional :sending_phone_number_profile_id, String, nil?: true
+
+      # @!attribute settings
+      #   Profile configuration settings
+      #
+      #   @return [Sentdm::Models::ProfileSettings, nil]
+      optional :settings, -> { Sentdm::ProfileSettings }, nil?: true
+
+      # @!attribute short_name
+      #   Short name / abbreviation (only for profile type)
+      #
+      #   @return [String, nil]
+      optional :short_name, String, nil?: true
+
+      # @!attribute status
+      #   Profile status (only for profile type): incomplete, pending_review, approved,
+      #   etc.
+      #
+      #   @return [String, nil]
+      optional :status, String, nil?: true
+
+      # @!attribute type
+      #   Account type: "organization" (has profiles), "user" (no profiles), or "profile"
+      #   (child of an organization)
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!method initialize(id: nil, channels: nil, created_at: nil, description: nil, email: nil, enable_template_auto_creation_for_sp: nil, icon: nil, name: nil, organization_id: nil, profiles: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, settings: nil, short_name: nil, status: nil, type: nil)
+      #   Some parameter documentations has been truncated, see {Sentdm::Models::Account}
+      #   for more details.
+      #
+      #   Account response for GET /v3/me endpoint. Returns organization (with profiles),
+      #   user (standalone), or profile (child of an organization) data depending on the
+      #   API key type. Always includes messaging channel configuration.
+      #
+      #   @param id [String] Customer ID (organization, account, or profile)
+      #
+      #   @param channels [Sentdm::Models::AccountChannels] Messaging channel configuration. All three channels are always present.
+      #
+      #   @param created_at [Time] When the account was created
+      #
+      #   @param description [String, nil] Account description
+      #
+      #   @param email [String, nil] Contact email address
+      #
+      #   @param enable_template_auto_creation_for_sp [Boolean] Whether this account may mark a template for automatic creation on its sender pr
+      #
+      #   @param icon [String, nil] Account icon URL
+      #
+      #   @param name [String] Account name
+      #
+      #   @param organization_id [String, nil] Organization ID (only for profile type — the parent organization)
+      #
+      #   @param profiles [Array<Sentdm::Models::AccountProfile>] List of profiles (populated for organization type, empty for user and profile ty
+      #
+      #   @param sending_phone_number [String, nil] The SMS sender this account sends from in the United States, in E.164 form. Null
+      #
+      #   @param sending_phone_number_profile_id [String, nil] The account that holds sending_phone_number in number inventory: normally this a
+      #
+      #   @param settings [Sentdm::Models::ProfileSettings, nil] Profile configuration settings
+      #
+      #   @param short_name [String, nil] Short name / abbreviation (only for profile type)
+      #
+      #   @param status [String, nil] Profile status (only for profile type): incomplete, pending_review, approved, et
+      #
+      #   @param type [String] Account type: "organization" (has profiles), "user" (no profiles), or "profile"
+    end
+  end
+end

data/lib/sentdm/models/account_channels.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class AccountChannels < Sentdm::Internal::Type::BaseModel
+      # @!attribute rcs
+      #   RCS channel configuration. When configured, includes the RCS phone number.
+      #
+      #   @return [Sentdm::Models::AccountRcsChannel, nil]
+      optional :rcs, -> { Sentdm::AccountRcsChannel }
+
+      # @!attribute sms
+      #   SMS channel configuration. When configured, includes the sending phone number.
+      #
+      #   @return [Sentdm::Models::AccountSMSChannel, nil]
+      optional :sms, -> { Sentdm::AccountSMSChannel }
+
+      # @!attribute whatsapp
+      #   WhatsApp Business channel configuration. When configured, includes the WhatsApp
+      #   phone number and business name.
+      #
+      #   @return [Sentdm::Models::AccountWhatsappChannel, nil]
+      optional :whatsapp, -> { Sentdm::AccountWhatsappChannel }
+
+      # @!method initialize(rcs: nil, sms: nil, whatsapp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::AccountChannels} for more details.
+      #
+      #   Messaging channel configuration. All three channels are always present. Each
+      #   channel has a "configured" flag; configured channels expose additional details.
+      #
+      #   @param rcs [Sentdm::Models::AccountRcsChannel] RCS channel configuration. When configured, includes the RCS phone number.
+      #
+      #   @param sms [Sentdm::Models::AccountSMSChannel] SMS channel configuration. When configured, includes the sending phone number.
+      #
+      #   @param whatsapp [Sentdm::Models::AccountWhatsappChannel] WhatsApp Business channel configuration. When configured, includes the WhatsApp
+    end
+  end
+end

data/lib/sentdm/models/account_profile.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class AccountProfile < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #   Profile unique identifier
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute created_at
+      #   When the profile was created
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute description
+      #   Profile description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute icon
+      #   Profile icon URL
+      #
+      #   @return [String, nil]
+      optional :icon, String, nil?: true
+
+      # @!attribute name
+      #   Profile name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute role
+      #   User's role in this profile: admin, billing, developer (inherited from
+      #   organization if not explicitly set)
+      #
+      #   @return [String, nil]
+      optional :role, String, nil?: true
+
+      # @!attribute settings
+      #   Profile configuration settings
+      #
+      #   @return [Sentdm::Models::ProfileSettings, nil]
+      optional :settings, -> { Sentdm::ProfileSettings }
+
+      # @!attribute short_name
+      #   Profile short name (abbreviation)
+      #
+      #   @return [String, nil]
+      optional :short_name, String, nil?: true
+
+      # @!attribute status
+      #   Profile setup status: incomplete, pending_review, approved, rejected
+      #
+      #   @return [String, nil]
+      optional :status, String, nil?: true
+
+      # @!method initialize(id: nil, created_at: nil, description: nil, icon: nil, name: nil, role: nil, settings: nil, short_name: nil, status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::AccountProfile} for more details.
+      #
+      #   Profile (sender profile) response for v3 API
+      #
+      #   @param id [String] Profile unique identifier
+      #
+      #   @param created_at [Time] When the profile was created
+      #
+      #   @param description [String, nil] Profile description
+      #
+      #   @param icon [String, nil] Profile icon URL
+      #
+      #   @param name [String] Profile name
+      #
+      #   @param role [String, nil] User's role in this profile: admin, billing, developer (inherited from organizat
+      #
+      #   @param settings [Sentdm::Models::ProfileSettings] Profile configuration settings
+      #
+      #   @param short_name [String, nil] Profile short name (abbreviation)
+      #
+      #   @param status [String, nil] Profile setup status: incomplete, pending_review, approved, rejected
+    end
+  end
+end