sentdm 0.45.0 → 0.47.0

data/lib/sentdm.rb

@@ -55,36 +55,89 @@ require_relative "sentdm/client"
 require_relative "sentdm/internal/calls_page"
 require_relative "sentdm/internal/contacts_page"
 require_relative "sentdm/internal/conversations_page"
+require_relative "sentdm/internal/sender_profiles_page"
 require_relative "sentdm/internal/templates_page"
 require_relative "sentdm/internal/voice_agents_page"
 require_relative "sentdm/internal/webhook_events_page"
 require_relative "sentdm/internal/webhooks_page"
+require_relative "sentdm/models/message"
 require_relative "sentdm/models/channels/voice_number"
 require_relative "sentdm/models/mutation_request"
 require_relative "sentdm/models/template_body_content"
+require_relative "sentdm/models/account"
+require_relative "sentdm/models/account_channels"
+require_relative "sentdm/models/account_profile"
+require_relative "sentdm/models/account_rcs_channel"
+require_relative "sentdm/models/account_sms_channel"
+require_relative "sentdm/models/account_whatsapp_channel"
 require_relative "sentdm/models/api_meta"
+require_relative "sentdm/models/api_response_of_account"
+require_relative "sentdm/models/api_response_of_cancelled_message"
+require_relative "sentdm/models/api_response_of_channels_state"
+require_relative "sentdm/models/api_response_of_compliance_requirements"
 require_relative "sentdm/models/api_response_of_contact"
 require_relative "sentdm/models/api_response_of_contact_message_summary"
+require_relative "sentdm/models/api_response_of_contacts_list"
 require_relative "sentdm/models/api_response_of_conversation_messages_list"
+require_relative "sentdm/models/api_response_of_message"
+require_relative "sentdm/models/api_response_of_message_activities"
+require_relative "sentdm/models/api_response_of_number_lookup_result"
+require_relative "sentdm/models/api_response_of_profile_completion_accepted"
+require_relative "sentdm/models/api_response_of_profile_completion_result"
 require_relative "sentdm/models/api_response_of_profile_detail"
+require_relative "sentdm/models/api_response_of_profiles_list"
+require_relative "sentdm/models/api_response_of_sender_profile"
+require_relative "sentdm/models/api_response_of_sender_profiles_list"
+require_relative "sentdm/models/api_response_of_templates_list"
 require_relative "sentdm/models/api_response_of_user"
+require_relative "sentdm/models/api_response_of_users_list"
+require_relative "sentdm/models/api_response_of_webhook_events_list"
+require_relative "sentdm/models/api_response_of_webhook_event_types_list"
+require_relative "sentdm/models/api_response_of_webhook_secret"
+require_relative "sentdm/models/api_response_of_webhooks_list"
+require_relative "sentdm/models/api_response_of_webhook_test"
 require_relative "sentdm/models/api_response_template"
 require_relative "sentdm/models/api_response_webhook"
 require_relative "sentdm/models/authentication_config"
+require_relative "sentdm/models/billing_contact"
 require_relative "sentdm/models/billing_contact_info"
+require_relative "sentdm/models/brand_business"
 require_relative "sentdm/models/brand_business_info"
+require_relative "sentdm/models/brand_compliance"
 require_relative "sentdm/models/brand_compliance_info"
+require_relative "sentdm/models/brand_contact"
 require_relative "sentdm/models/brand_contact_info"
 require_relative "sentdm/models/brands_brand_data"
+require_relative "sentdm/models/brand_with_kyc"
 require_relative "sentdm/models/call_event"
 require_relative "sentdm/models/call_event_payload"
+require_relative "sentdm/models/cancelled_message"
 require_relative "sentdm/models/channel_event"
 require_relative "sentdm/models/channel_event_payload"
+require_relative "sentdm/models/channel_list_params"
+require_relative "sentdm/models/channels/api_response_of_list_of_sms_market"
 require_relative "sentdm/models/channels/api_response_of_list_of_voice_number"
+require_relative "sentdm/models/channels/api_response_of_rcs_agent"
+require_relative "sentdm/models/channels/api_response_of_sms_market"
 require_relative "sentdm/models/channels/api_response_of_voice_callback_test"
 require_relative "sentdm/models/channels/api_response_of_voice_number"
 require_relative "sentdm/models/channels/api_response_of_voice_number_created"
 require_relative "sentdm/models/channels/api_response_of_voice_secret"
+require_relative "sentdm/models/channels/api_response_of_whatsapp_channel"
+require_relative "sentdm/models/channels/market_compliance"
+require_relative "sentdm/models/channels/rc_create_params"
+require_relative "sentdm/models/channels/rcs_address"
+require_relative "sentdm/models/channels/rcs_agent"
+require_relative "sentdm/models/channels/sms_create_params"
+require_relative "sentdm/models/channels/sms_list_params"
+require_relative "sentdm/models/channels/sms_market"
+require_relative "sentdm/models/channels/sms_number"
+require_relative "sentdm/models/channels/sms_number_request"
+require_relative "sentdm/models/channels/sms_retrieve_params"
+require_relative "sentdm/models/channels/sms_update_params"
+require_relative "sentdm/models/channels/supplied_campaign"
+require_relative "sentdm/models/channels/supplied_compliance"
+require_relative "sentdm/models/channels/supplied_document"
 require_relative "sentdm/models/channels/voice_callback_test"
 require_relative "sentdm/models/channels/voice_callback_test_error_info"
 require_relative "sentdm/models/channels/voice_callback_test_request_info"
@@ -97,6 +150,15 @@ require_relative "sentdm/models/channels/voice_rotate_secret_params"
 require_relative "sentdm/models/channels/voice_secret"
 require_relative "sentdm/models/channels/voice_test_params"
 require_relative "sentdm/models/channels/voice_update_params"
+require_relative "sentdm/models/channels/whatsapp_channel"
+require_relative "sentdm/models/channels/whatsapp_create_params"
+require_relative "sentdm/models/channel_score"
+require_relative "sentdm/models/channels_state"
+require_relative "sentdm/models/compliance_attachment_template"
+require_relative "sentdm/models/compliance_requirement"
+require_relative "sentdm/models/compliance_requirements"
+require_relative "sentdm/models/compliance_retrieve_requirements_params"
+require_relative "sentdm/models/compliance_setup_step"
 require_relative "sentdm/models/contact_create_params"
 require_relative "sentdm/models/contact_delete_params"
 require_relative "sentdm/models/contact_event"
@@ -106,36 +168,51 @@ require_relative "sentdm/models/contact_message_summary"
 require_relative "sentdm/models/contact_response"
 require_relative "sentdm/models/contact_retrieve_message_summary_params"
 require_relative "sentdm/models/contact_retrieve_params"
+require_relative "sentdm/models/contacts_list"
 require_relative "sentdm/models/contact_update_params"
 require_relative "sentdm/models/conversation_list_messages_params"
 require_relative "sentdm/models/conversation_list_params"
 require_relative "sentdm/models/conversation_messages_list"
 require_relative "sentdm/models/destination_country"
+require_relative "sentdm/models/entity_type"
 require_relative "sentdm/models/error_detail"
+require_relative "sentdm/models/inbound_media"
 require_relative "sentdm/models/inbound_message_event"
 require_relative "sentdm/models/inbound_message_event_payload"
+require_relative "sentdm/models/link_event"
+require_relative "sentdm/models/link_event_payload"
 require_relative "sentdm/models/me_retrieve_params"
-require_relative "sentdm/models/me_retrieve_response"
+require_relative "sentdm/models/message_activities"
+require_relative "sentdm/models/message_activity"
+require_relative "sentdm/models/message_body"
+require_relative "sentdm/models/message_button"
+require_relative "sentdm/models/message_cancel_params"
+require_relative "sentdm/models/message_channel_options"
 require_relative "sentdm/models/message_event"
 require_relative "sentdm/models/message_event_payload"
+require_relative "sentdm/models/message_header_media"
+require_relative "sentdm/models/message_media"
+require_relative "sentdm/models/message_recipient"
 require_relative "sentdm/models/message_resend_params"
 require_relative "sentdm/models/message_retrieve_activities_params"
-require_relative "sentdm/models/message_retrieve_activities_response"
 require_relative "sentdm/models/message_retrieve_status_params"
-require_relative "sentdm/models/message_retrieve_status_response"
 require_relative "sentdm/models/message_send_params"
 require_relative "sentdm/models/message_send_response"
+require_relative "sentdm/models/message_send_result"
+require_relative "sentdm/models/message_status_event"
+require_relative "sentdm/models/mms_market"
 require_relative "sentdm/models/number_lookup_params"
-require_relative "sentdm/models/number_lookup_response"
+require_relative "sentdm/models/number_lookup_result"
+require_relative "sentdm/models/pagination_cursors"
 require_relative "sentdm/models/pagination_meta"
 require_relative "sentdm/models/payment_details"
 require_relative "sentdm/models/profile_complete_params"
-require_relative "sentdm/models/profile_complete_response"
+require_relative "sentdm/models/profile_completion_accepted"
+require_relative "sentdm/models/profile_completion_result"
 require_relative "sentdm/models/profile_create_params"
 require_relative "sentdm/models/profile_delete_params"
 require_relative "sentdm/models/profile_detail"
 require_relative "sentdm/models/profile_list_params"
-require_relative "sentdm/models/profile_list_response"
 require_relative "sentdm/models/profile_retrieve_params"
 require_relative "sentdm/models/profiles/api_response_of_brand_campaign"
 require_relative "sentdm/models/profiles/api_response_of_list_of_brand_campaign"
@@ -149,8 +226,25 @@ require_relative "sentdm/models/profiles/campaign_use_case"
 require_relative "sentdm/models/profiles/campaign_use_case_data"
 require_relative "sentdm/models/profiles/messaging_use_case_us"
 require_relative "sentdm/models/profile_settings"
+require_relative "sentdm/models/profiles_list"
 require_relative "sentdm/models/profile_update_params"
+require_relative "sentdm/models/sender_profile"
+require_relative "sentdm/models/sender_profile_billing"
+require_relative "sentdm/models/sender_profile_billing_request"
+require_relative "sentdm/models/sender_profile_channels"
+require_relative "sentdm/models/sender_profile_create_params"
+require_relative "sentdm/models/sender_profile_delete_params"
+require_relative "sentdm/models/sender_profile_list_params"
+require_relative "sentdm/models/sender_profile_rcs"
+require_relative "sentdm/models/sender_profile_retrieve_params"
+require_relative "sentdm/models/sender_profiles_list"
+require_relative "sentdm/models/sender_profile_sms"
+require_relative "sentdm/models/sender_profile_update_params"
+require_relative "sentdm/models/sender_profile_whatsapp"
+require_relative "sentdm/models/tcr_brand_identity_status"
 require_relative "sentdm/models/tcr_brand_relationship"
+require_relative "sentdm/models/tcr_brand_status"
+require_relative "sentdm/models/tcr_campaign_status"
 require_relative "sentdm/models/tcr_vertical"
 require_relative "sentdm/models/template"
 require_relative "sentdm/models/template_body"
@@ -163,16 +257,22 @@ require_relative "sentdm/models/template_event"
 require_relative "sentdm/models/template_event_payload"
 require_relative "sentdm/models/template_footer"
 require_relative "sentdm/models/template_header"
+require_relative "sentdm/models/template_header_location"
 require_relative "sentdm/models/template_list_params"
+require_relative "sentdm/models/template_media_item"
+require_relative "sentdm/models/template_mms_body_content"
+require_relative "sentdm/models/template_ref"
 require_relative "sentdm/models/template_retrieve_params"
+require_relative "sentdm/models/templates_list"
 require_relative "sentdm/models/template_update_params"
 require_relative "sentdm/models/template_variable"
+require_relative "sentdm/models/template_variable_props"
 require_relative "sentdm/models/user_invite_params"
 require_relative "sentdm/models/user_list_params"
-require_relative "sentdm/models/user_list_response"
 require_relative "sentdm/models/user_remove_params"
 require_relative "sentdm/models/user_response"
 require_relative "sentdm/models/user_retrieve_params"
+require_relative "sentdm/models/users_list"
 require_relative "sentdm/models/user_update_role_params"
 require_relative "sentdm/models/voice/agent_create_params"
 require_relative "sentdm/models/voice/agent_delete_params"
@@ -190,6 +290,7 @@ require_relative "sentdm/models/voice/api_response_of_voice_catalogue"
 require_relative "sentdm/models/voice/api_response_of_voice_token"
 require_relative "sentdm/models/voice/call"
 require_relative "sentdm/models/voice/call_hangup_params"
+require_relative "sentdm/models/voice/call_leg"
 require_relative "sentdm/models/voice/call_list_params"
 require_relative "sentdm/models/voice/call_list_recordings_params"
 require_relative "sentdm/models/voice/call_party"
@@ -227,23 +328,31 @@ require_relative "sentdm/models/voice/voice_catalogue_voice"
 require_relative "sentdm/models/voice/voice_token"
 require_relative "sentdm/models/webhook_create_params"
 require_relative "sentdm/models/webhook_delete_params"
+require_relative "sentdm/models/webhook_delivery"
+require_relative "sentdm/models/webhook_events_list"
 require_relative "sentdm/models/webhook_event_type"
+require_relative "sentdm/models/webhook_event_types_list"
 require_relative "sentdm/models/webhook_list_events_params"
-require_relative "sentdm/models/webhook_list_events_response"
 require_relative "sentdm/models/webhook_list_event_types_params"
-require_relative "sentdm/models/webhook_list_event_types_response"
 require_relative "sentdm/models/webhook_list_params"
 require_relative "sentdm/models/webhook_response"
 require_relative "sentdm/models/webhook_retrieve_params"
 require_relative "sentdm/models/webhook_rotate_secret_params"
-require_relative "sentdm/models/webhook_rotate_secret_response"
+require_relative "sentdm/models/webhook_secret"
+require_relative "sentdm/models/webhook_sender_profile"
+require_relative "sentdm/models/webhook_sender_profile_config"
+require_relative "sentdm/models/webhooks_list"
+require_relative "sentdm/models/webhook_test"
 require_relative "sentdm/models/webhook_test_params"
-require_relative "sentdm/models/webhook_test_response"
 require_relative "sentdm/models/webhook_toggle_status_params"
 require_relative "sentdm/models/webhook_update_params"
 require_relative "sentdm/models"
 require_relative "sentdm/resources/channels"
+require_relative "sentdm/resources/channels/rcs"
+require_relative "sentdm/resources/channels/sms"
 require_relative "sentdm/resources/channels/voice"
+require_relative "sentdm/resources/channels/whatsapp"
+require_relative "sentdm/resources/compliance"
 require_relative "sentdm/resources/contacts"
 require_relative "sentdm/resources/conversations"
 require_relative "sentdm/resources/me"
@@ -251,6 +360,7 @@ require_relative "sentdm/resources/messages"
 require_relative "sentdm/resources/numbers"
 require_relative "sentdm/resources/profiles"
 require_relative "sentdm/resources/profiles/campaigns"
+require_relative "sentdm/resources/sender_profiles"
 require_relative "sentdm/resources/templates"
 require_relative "sentdm/resources/users"
 require_relative "sentdm/resources/voice"

data/rbi/sentdm/client.rbi

@@ -58,6 +58,26 @@ module Sentdm
     sig { returns(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 reaches only the countries
+    # Sent runs a shared route for, and the US is not one of them.
+    #
+    # 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.
+    sig { returns(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
@@ -118,9 +138,53 @@ module Sentdm
     sig { returns(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.
     sig { returns(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**.
+    sig { returns(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

data/rbi/sentdm/internal/sender_profiles_page.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module Sentdm
+  module Internal
+    class SenderProfilesPage
+      include Sentdm::Internal::Type::BasePage
+
+      Elem = type_member
+
+      sig { returns(Data) }
+      attr_accessor :data
+
+      # @api private
+      sig { returns(String) }
+      def inspect
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Data, Sentdm::Internal::AnyHash) }
+
+        sig { returns(T.nilable(Data::Pagination)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Data::Pagination::OrHash).void }
+        attr_writer :pagination
+
+        sig { returns(T.nilable(T::Array[T.anything])) }
+        attr_reader :sender_profiles
+
+        sig { params(sender_profiles: T::Array[T.anything]).void }
+        attr_writer :sender_profiles
+
+        sig do
+          params(
+            pagination: Data::Pagination::OrHash,
+            sender_profiles: T::Array[T.anything]
+          ).returns(T.attached_class)
+        end
+        def self.new(pagination: nil, sender_profiles: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              pagination: Data::Pagination,
+              sender_profiles: T::Array[T.anything]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(Data::Pagination, Sentdm::Internal::AnyHash) }
+
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page
+
+          sig { params(page: Integer).void }
+          attr_writer :page
+
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page_size
+
+          sig { params(page_size: Integer).void }
+          attr_writer :page_size
+
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :total_count
+
+          sig { params(total_count: Integer).void }
+          attr_writer :total_count
+
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :total_pages
+
+          sig { params(total_pages: Integer).void }
+          attr_writer :total_pages
+
+          sig do
+            params(
+              has_more: T::Boolean,
+              page: Integer,
+              page_size: Integer,
+              total_count: Integer,
+              total_pages: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            has_more: nil,
+            page: nil,
+            page_size: nil,
+            total_count: nil,
+            total_pages: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                has_more: T::Boolean,
+                page: Integer,
+                page_size: Integer,
+                total_count: Integer,
+                total_pages: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end