sentdm 0.25.0 → 0.27.0

data/lib/sentdm/models/template_event_payload.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class TemplateEventPayload < Sentdm::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The account the template belongs to.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute category
+      #   The template's category, for example UTILITY, MARKETING, or AUTHENTICATION.
+      #
+      #   @return [String, nil]
+      optional :category, String
+
+      # @!attribute channel
+      #   The channel the template applies to.
+      #
+      #   @return [String, nil]
+      optional :channel, String
+
+      # @!attribute language
+      #   The template's language code, for example en_US.
+      #
+      #   @return [String, nil]
+      optional :language, String
+
+      # @!attribute reason
+      #   Why the template reached Status, when a reason was given. Populated on a
+      #   rejection.
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute status
+      #   The review status the template just reached, for example APPROVED or REJECTED.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute template_id
+      #   The template in Sent.
+      #
+      #   @return [String, nil]
+      optional :template_id, String
+
+      # @!attribute template_name
+      #   The template's display name.
+      #
+      #   @return [String, nil]
+      optional :template_name, String
+
+      # @!attribute whatsapp_template_id
+      #   The template's identifier with Meta, assigned when the template is submitted for
+      #   review.
+      #
+      #   @return [String, nil]
+      optional :whatsapp_template_id, String
+
+      # @!method initialize(account_id: nil, category: nil, channel: nil, language: nil, reason: nil, status: nil, template_id: nil, template_name: nil, whatsapp_template_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateEventPayload} for more details.
+      #
+      #   Body of a template status event. Delivered when a template's review outcome
+      #   changes, so you can react without polling.
+      #
+      #   @param account_id [String] The account the template belongs to.
+      #
+      #   @param category [String] The template's category, for example UTILITY, MARKETING, or
+      #
+      #   @param channel [String] The channel the template applies to.
+      #
+      #   @param language [String] The template's language code, for example en_US.
+      #
+      #   @param reason [String, nil] Why the template reached Status, when a reason was given. Populated on a
+      #
+      #   @param status [String] The review status the template just reached, for example APPROVED or
+      #
+      #   @param template_id [String] The template in Sent.
+      #
+      #   @param template_name [String] The template's display name.
+      #
+      #   @param whatsapp_template_id [String] The template's identifier with Meta, assigned when the template is submitted for
+    end
+  end
+end

data/lib/sentdm/models/{sent_dm_services_common_contracts_poc_os_template_footer.rb → template_footer.rb}

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class SentDmServicesCommonContractsPocOsTemplateFooter < Sentdm::Internal::Type::BaseModel
+    class TemplateFooter < Sentdm::Internal::Type::BaseModel
       # @!attribute template
       #   The footer template text with optional variable placeholders
       #

data/lib/sentdm/models/{sent_dm_services_common_contracts_poc_os_template_header.rb → template_header.rb}

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class SentDmServicesCommonContractsPocOsTemplateHeader < Sentdm::Internal::Type::BaseModel
+    class TemplateHeader < Sentdm::Internal::Type::BaseModel
       # @!attribute template
       #   The header template text with optional variable placeholders (e.g., "Welcome to
       #   {{0:variable}}")
@@ -24,8 +24,7 @@ module Sentdm
 
       # @!method initialize(template:, type: nil, variables: nil)
       #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader} for more
-      #   details.
+      #   {Sentdm::Models::TemplateHeader} for more details.
       #
       #   Header section of a message template
       #

data/lib/sentdm/models/webhook_list_events_response.rb

@@ -87,9 +87,13 @@ module Sentdm
           optional :error_message, String, nil?: true
 
           # @!attribute event_data
+          #   The exact event body that was delivered, or attempted, for this record. One of
+          #   the three webhook envelopes: a message status change, an inbound message, or a
+          #   template status change. Read field and event to tell which, the same way your
+          #   endpoint does.
           #
-          #   @return [Object, nil]
-          optional :event_data, Sentdm::Internal::Type::Unknown
+          #   @return [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, nil]
+          optional :event_data, union: -> { Sentdm::Models::WebhookListEventsResponse::Data::Event::EventData }
 
           # @!attribute event_type
           #
@@ -117,17 +121,55 @@ module Sentdm
           optional :response_body, String, nil?: true
 
           # @!method initialize(id: nil, created_at: nil, delivery_attempts: nil, delivery_status: nil, error_message: nil, event_data: nil, event_type: nil, http_status_code: nil, processing_completed_at: nil, processing_started_at: nil, response_body: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::WebhookListEventsResponse::Data::Event} for more details.
+          #
           #   @param id [String]
+          #
           #   @param created_at [Time]
+          #
           #   @param delivery_attempts [Integer]
+          #
           #   @param delivery_status [String]
+          #
           #   @param error_message [String, nil]
-          #   @param event_data [Object]
+          #
+          #   @param event_data [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent] The exact event body that was delivered, or attempted, for this record. One of t
+          #
           #   @param event_type [String]
+          #
           #   @param http_status_code [Integer, nil]
+          #
           #   @param processing_completed_at [Time, nil]
+          #
           #   @param processing_started_at [Time, nil]
+          #
           #   @param response_body [String, nil]
+
+          # The exact event body that was delivered, or attempted, for this record. One of
+          # the three webhook envelopes: a message status change, an inbound message, or a
+          # template status change. Read field and event to tell which, the same way your
+          # endpoint does.
+          #
+          # @see Sentdm::Models::WebhookListEventsResponse::Data::Event#event_data
+          module EventData
+            extend Sentdm::Internal::Type::Union
+
+            # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
+            # varies only in Payload.
+            variant -> { Sentdm::MessageEvent }
+
+            # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
+            # varies only in Payload.
+            variant -> { Sentdm::InboundMessageEvent }
+
+            # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
+            # varies only in Payload.
+            variant -> { Sentdm::TemplateEvent }
+
+            # @!method self.variants
+            #   @return [Array(Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent)]
+          end
         end
       end
     end

data/lib/sentdm/models.rb

@@ -43,6 +43,10 @@ module Sentdm
 
   APIResponseOfContact = Sentdm::Models::APIResponseOfContact
 
+  APIResponseOfContactMessageSummary = Sentdm::Models::APIResponseOfContactMessageSummary
+
+  APIResponseOfConversationMessagesList = Sentdm::Models::APIResponseOfConversationMessagesList
+
   APIResponseOfProfileDetail = Sentdm::Models::APIResponseOfProfileDetail
 
   APIResponseOfUser = Sentdm::Models::APIResponseOfUser
@@ -51,8 +55,16 @@ module Sentdm
 
   APIResponseWebhook = Sentdm::Models::APIResponseWebhook
 
+  AuthenticationConfig = Sentdm::Models::AuthenticationConfig
+
   BillingContactInfo = Sentdm::Models::BillingContactInfo
 
+  BrandBusinessInfo = Sentdm::Models::BrandBusinessInfo
+
+  BrandComplianceInfo = Sentdm::Models::BrandComplianceInfo
+
+  BrandContactInfo = Sentdm::Models::BrandContactInfo
+
   BrandsBrandData = Sentdm::Models::BrandsBrandData
 
   ContactCreateParams = Sentdm::Models::ContactCreateParams
@@ -61,18 +73,36 @@ module Sentdm
 
   ContactListParams = Sentdm::Models::ContactListParams
 
+  ContactMessageSummary = Sentdm::Models::ContactMessageSummary
+
   ContactResponse = Sentdm::Models::ContactResponse
 
+  ContactRetrieveMessageSummaryParams = Sentdm::Models::ContactRetrieveMessageSummaryParams
+
   ContactRetrieveParams = Sentdm::Models::ContactRetrieveParams
 
   ContactUpdateParams = Sentdm::Models::ContactUpdateParams
 
+  ConversationListMessagesParams = Sentdm::Models::ConversationListMessagesParams
+
+  ConversationListParams = Sentdm::Models::ConversationListParams
+
+  ConversationMessagesList = Sentdm::Models::ConversationMessagesList
+
   DestinationCountry = Sentdm::Models::DestinationCountry
 
   ErrorDetail = Sentdm::Models::ErrorDetail
 
+  InboundMessageEvent = Sentdm::Models::InboundMessageEvent
+
+  InboundMessageEventPayload = Sentdm::Models::InboundMessageEventPayload
+
   MeRetrieveParams = Sentdm::Models::MeRetrieveParams
 
+  MessageEvent = Sentdm::Models::MessageEvent
+
+  MessageEventPayload = Sentdm::Models::MessageEventPayload
+
   MessageRetrieveActivitiesParams = Sentdm::Models::MessageRetrieveActivitiesParams
 
   MessageRetrieveStatusParams = Sentdm::Models::MessageRetrieveStatusParams
@@ -105,47 +135,34 @@ module Sentdm
 
   ProfileUpdateParams = Sentdm::Models::ProfileUpdateParams
 
-  SentDmServicesCommonContractsPocOsAuthenticationConfig =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig
-
-  SentDmServicesCommonContractsPocOsTemplateBody =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody
-
-  SentDmServicesCommonContractsPocOsTemplateButton =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton
-
-  SentDmServicesCommonContractsPocOsTemplateButtonProps =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps
-
-  SentDmServicesCommonContractsPocOsTemplateFooter =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter
-
-  SentDmServicesCommonContractsPocOsTemplateHeader =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader
-
-  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo =
-    Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo
-
-  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo =
-    Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo
-
-  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo =
-    Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo
-
   TcrBrandRelationship = Sentdm::Models::TcrBrandRelationship
 
   TcrVertical = Sentdm::Models::TcrVertical
 
   Template = Sentdm::Models::Template
 
+  TemplateBody = Sentdm::Models::TemplateBody
+
   TemplateBodyContent = Sentdm::Models::TemplateBodyContent
 
+  TemplateButton = Sentdm::Models::TemplateButton
+
+  TemplateButtonProps = Sentdm::Models::TemplateButtonProps
+
   TemplateCreateParams = Sentdm::Models::TemplateCreateParams
 
   TemplateDefinition = Sentdm::Models::TemplateDefinition
 
   TemplateDeleteParams = Sentdm::Models::TemplateDeleteParams
 
+  TemplateEvent = Sentdm::Models::TemplateEvent
+
+  TemplateEventPayload = Sentdm::Models::TemplateEventPayload
+
+  TemplateFooter = Sentdm::Models::TemplateFooter
+
+  TemplateHeader = Sentdm::Models::TemplateHeader
+
   TemplateListParams = Sentdm::Models::TemplateListParams
 
   TemplateRetrieveParams = Sentdm::Models::TemplateRetrieveParams

data/lib/sentdm/resources/contacts.rb

@@ -176,6 +176,36 @@ module Sentdm
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ContactRetrieveMessageSummaryParams} for more details.
+      #
+      # Returns aggregate message counts, time bounds, channels used, and per-channel
+      # success/fail scores (each as a percentage 0-100 of messages on that channel) for
+      # one of your contacts. Successful terminal states: SENT/DELIVERED/READ for
+      # outbound, RECEIVED for inbound. Fail: FAILED.
+      #
+      # @overload retrieve_message_summary(contact_id, x_profile_id: nil, request_options: {})
+      #
+      # @param contact_id [String]
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::APIResponseOfContactMessageSummary]
+      #
+      # @see Sentdm::Models::ContactRetrieveMessageSummaryParams
+      def retrieve_message_summary(contact_id, params = {})
+        parsed, options = Sentdm::ContactRetrieveMessageSummaryParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["v3/contacts/%1$s/message-summary", contact_id],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
+          model: Sentdm::APIResponseOfContactMessageSummary,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [Sentdm::Client]

data/lib/sentdm/resources/conversations.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Resources
+    class Conversations
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ConversationListParams} for more details.
+      #
+      # Retrieves a paginated list of the authenticated customer's messages across all
+      # conversations, ordered by created date (most recent first).
+      #
+      # @overload list(page:, page_size:, x_profile_id: nil, request_options: {})
+      #
+      # @param page [Integer] Query param
+      #
+      # @param page_size [Integer] Query param
+      #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::APIResponseOfConversationMessagesList]
+      #
+      # @see Sentdm::Models::ConversationListParams
+      def list(params)
+        query_params = [:page, :page_size]
+        parsed, options = Sentdm::ConversationListParams.dump_request(params)
+        query = Sentdm::Internal::Util.encode_query_params(parsed.slice(*query_params))
+        @client.request(
+          method: :get,
+          path: "v3/conversations",
+          query: query,
+          headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
+          model: Sentdm::APIResponseOfConversationMessagesList,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ConversationListMessagesParams} for more details.
+      #
+      # Retrieves a paginated list of the messages in a single conversation (scoped to
+      # the authenticated customer), ordered by created date (most recent first).
+      #
+      # @overload list_messages(id, page:, page_size:, x_profile_id: nil, request_options: {})
+      #
+      # @param id [String] Path param: Conversation id from the route.
+      #
+      # @param page [Integer] Query param
+      #
+      # @param page_size [Integer] Query param
+      #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
+      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Sentdm::Models::APIResponseOfConversationMessagesList]
+      #
+      # @see Sentdm::Models::ConversationListMessagesParams
+      def list_messages(id, params)
+        query_params = [:page, :page_size]
+        parsed, options = Sentdm::ConversationListMessagesParams.dump_request(params)
+        query = Sentdm::Internal::Util.encode_query_params(parsed.slice(*query_params))
+        @client.request(
+          method: :get,
+          path: ["v3/conversations/%1$s", id],
+          query: query,
+          headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
+          model: Sentdm::APIResponseOfConversationMessagesList,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Sentdm::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/sentdm/resources/messages.rb

@@ -67,7 +67,12 @@ module Sentdm
       # multi-channel broadcast — when multiple channels are specified (e.g. ["sms",
       # "whatsapp"]), a separate message is created for each (recipient, channel) pair.
       # Returns immediately with per-recipient message IDs for async tracking via
-      # webhooks or the GET /messages/{id} endpoint.
+      # webhooks or the GET /messages/{id} endpoint. Sends gated before any delivery
+      # attempt do not reject the request — an account-level precondition such as
+      # insufficient balance, a template not approved for sending, or free-form content
+      # with no open conversation with the contact. The send is accepted with 202 and
+      # the affected messages are reported as BLOCKED on GET /messages/{id} and the
+      # message.blocked webhook.
       #
       # @overload send_(channel: nil, sandbox: nil, template: nil, text: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #

data/lib/sentdm/resources/profiles/campaigns.rb

@@ -25,7 +25,7 @@ module Sentdm
         #
         # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Sentdm::Models::Profiles::APIResponseOfTcrCampaignWithUseCases]
+        # @return [Sentdm::Models::Profiles::APIResponseOfBrandCampaign]
         #
         # @see Sentdm::Models::Profiles::CampaignCreateParams
         def create(profile_id, params)
@@ -36,7 +36,7 @@ module Sentdm
             path: ["v3/profiles/%1$s/campaigns", profile_id],
             headers: parsed.slice(*header_params.keys).transform_keys(header_params),
             body: parsed.except(*header_params.keys),
-            model: Sentdm::Profiles::APIResponseOfTcrCampaignWithUseCases,
+            model: Sentdm::Profiles::APIResponseOfBrandCampaign,
             options: options
           )
         end
@@ -63,7 +63,7 @@ module Sentdm
         #
         # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Sentdm::Models::Profiles::APIResponseOfTcrCampaignWithUseCases]
+        # @return [Sentdm::Models::Profiles::APIResponseOfBrandCampaign]
         #
         # @see Sentdm::Models::Profiles::CampaignUpdateParams
         def update(campaign_id, params)
@@ -78,7 +78,7 @@ module Sentdm
             path: ["v3/profiles/%1$s/campaigns/%2$s", profile_id, campaign_id],
             headers: parsed.slice(*header_params.keys).transform_keys(header_params),
             body: parsed.except(*header_params.keys),
-            model: Sentdm::Profiles::APIResponseOfTcrCampaignWithUseCases,
+            model: Sentdm::Profiles::APIResponseOfBrandCampaign,
             options: options
           )
         end
@@ -97,7 +97,7 @@ module Sentdm
         #
         # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Sentdm::Models::Profiles::CampaignListResponse]
+        # @return [Sentdm::Models::Profiles::APIResponseOfListOfBrandCampaign]
         #
         # @see Sentdm::Models::Profiles::CampaignListParams
         def list(profile_id, params = {})
@@ -106,7 +106,7 @@ module Sentdm
             method: :get,
             path: ["v3/profiles/%1$s/campaigns", profile_id],
             headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
-            model: Sentdm::Models::Profiles::CampaignListResponse,
+            model: Sentdm::Profiles::APIResponseOfListOfBrandCampaign,
             options: options
           )
         end

data/lib/sentdm/resources/profiles.rb

@@ -113,7 +113,7 @@ module Sentdm
       #
       # @overload retrieve(profile_id, x_profile_id: nil, request_options: {})
       #
-      # @param profile_id [String]
+      # @param profile_id [String] Profile ID from route parameter
       #
       # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
       #
@@ -157,7 +157,7 @@ module Sentdm
       #
       # @overload update(profile_id, allow_contact_sharing: nil, allow_number_change_during_onboarding: nil, allow_template_sharing: nil, billing_contact: nil, billing_model: nil, brand: nil, description: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, payment_details: nil, sandbox: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, sending_whatsapp_number_profile_id: nil, short_name: nil, whatsapp_phone_number: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
-      # @param profile_id [String] Path param
+      # @param profile_id [String] Path param: Profile ID from route parameter
       #
       # @param allow_contact_sharing [Boolean, nil] Body param: Whether contacts are shared across profiles (optional)
       #
@@ -191,7 +191,7 @@ module Sentdm
       #
       # @param sending_phone_number [String, nil] Body param: Direct phone number for SMS sending (optional)
       #
-      # @param sending_phone_number_profile_id [String, nil] Body param: Reference to another profile to use for SMS/Telnyx configuration (op
+      # @param sending_phone_number_profile_id [String, nil] Body param: Reference to another profile to use for SMS configuration (optional)
       #
       # @param sending_whatsapp_number_profile_id [String, nil] Body param: Reference to another profile to use for WhatsApp configuration (opti
       #
@@ -257,7 +257,7 @@ module Sentdm
       #
       # @overload delete(profile_id, sandbox: nil, x_profile_id: nil, request_options: {})
       #
-      # @param profile_id [String] Path param
+      # @param profile_id [String] Path param: Profile ID from route parameter
       #
       # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
@@ -284,24 +284,36 @@ module Sentdm
       # Some parameter documentations has been truncated, see
       # {Sentdm::Models::ProfileCompleteParams} for more details.
       #
-      # Final step in profile compliance workflow. Validates all prerequisites (general
-      # data, brand, campaigns), connects profile to Telnyx/WhatsApp, and sets status
-      # based on configuration. The process runs in the background and calls the
-      # provided webhook URL when finished.
-      #
-      #                 Prerequisites:
-      #                 - Profile must be completed
-      #                 - If inheritTcrBrand=false: Profile must have existing brand
-      #                 - If inheritTcrBrand=true: Parent must have existing brand
-      #                 - If TCR application: Must have at least one campaign (own or inherited)
-      #                 - If inheritTcrCampaign=false: Profile should have campaigns
-      #                 - If inheritTcrCampaign=true: Parent must have campaigns
-      #
-      #                 Status Logic:
-      #                 - If both SMS and WhatsApp channels are missing → SUBMITTED
-      #                 - If TCR application and not inheriting brand/campaigns → SUBMITTED
-      #                 - If non-TCR with destination country (IsMain=true) → SUBMITTED
-      #                 - Otherwise → COMPLETED
+      # Final step in the profile compliance workflow. Validates all prerequisites (KYC,
+      # brand, campaigns, required documents), connects the profile to the SMS and
+      # WhatsApp channels, and sets its status based on configuration. Prerequisites are
+      # always validated first: if any fail the call returns 400. If they pass and the
+      # profile is already completed, the call returns 200 and does nothing. Otherwise
+      # it returns 202 and calls the provided webhook URL when background processing
+      # finishes.
+      #
+      # Prerequisites:
+      #
+      # - Profile must have a name, short name, and description (short name max 50
+      #   characters, description max 5000)
+      # - webHookUrl must be supplied on the request
+      # - A KYC form submission is required
+      # - A brand is required, either on the profile or inherited from the parent
+      #   organization
+      # - TCR applications must have at least one campaign, own or inherited
+      # - Destination countries marked as main must have their required compliance
+      #   documents uploaded
+      #
+      # Resulting status:
+      #
+      # - If either the SMS or WhatsApp channel is unconfigured, the profile is
+      #   SUBMITTED
+      # - For a TCR application that inherits both its brand and its campaigns, the
+      #   profile is COMPLETED
+      # - For a TCR application that owns either its brand or its campaigns, the profile
+      #   is COMPLETED once both have been submitted to TCR, and SUBMITTED until then
+      # - For a non-TCR application, the profile is SUBMITTED when a main destination
+      #   country is set, and COMPLETED otherwise
       #
       # @overload complete(profile_id, web_hook_url:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #

data/lib/sentdm/resources/users.rb

@@ -12,7 +12,7 @@ module Sentdm
       #
       # @overload retrieve(user_id, x_profile_id: nil, request_options: {})
       #
-      # @param user_id [String]
+      # @param user_id [String] User ID from route parameter
       #
       # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
       #
@@ -106,7 +106,7 @@ module Sentdm
       #
       # @overload remove(user_id, sandbox: nil, x_profile_id: nil, request_options: {})
       #
-      # @param user_id [String] Path param
+      # @param user_id [String] Path param: User ID from route parameter
       #
       # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
@@ -138,7 +138,7 @@ module Sentdm
       #
       # @overload update_role(user_id, role: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
-      # @param user_id [String] Path param
+      # @param user_id [String] Path param: User ID from route parameter
       #
       # @param role [String] Body param: User role: admin, billing, or developer (required)
       #

data/lib/sentdm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentdm
-  VERSION = "0.25.0"
+  VERSION = "0.27.0"
 end