feat(api): sync OpenAPI spec from production

Stainless-Generated-From: c6fc73e611b365090249bd47a206eeff9f919050

Author: stlc-bot

api.md

@@ -114,20 +114,19 @@ Types:
 
 ```python
 from sent_dm.types.profiles import (
-    APIResponseOfTcrCampaignWithUseCases,
-    BaseDto,
     CampaignData,
     MessagingUseCaseUs,
     SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData,
-    TcrCampaignWithUseCases,
+    CampaignCreateResponse,
+    CampaignUpdateResponse,
     CampaignListResponse,
 )
 ```
 
 Methods:
 
-- <code title="post /v3/profiles/{profileId}/campaigns">client.profiles.campaigns.<a href="./src/sent_dm/resources/profiles/campaigns.py">create</a>(profile_id, \*\*<a href="src/sent_dm/types/profiles/campaign_create_params.py">params</a>) -> <a href="./src/sent_dm/types/profiles/api_response_of_tcr_campaign_with_use_cases.py">APIResponseOfTcrCampaignWithUseCases</a></code>
-- <code title="put /v3/profiles/{profileId}/campaigns/{campaignId}">client.profiles.campaigns.<a href="./src/sent_dm/resources/profiles/campaigns.py">update</a>(campaign_id, \*, profile_id, \*\*<a href="src/sent_dm/types/profiles/campaign_update_params.py">params</a>) -> <a href="./src/sent_dm/types/profiles/api_response_of_tcr_campaign_with_use_cases.py">APIResponseOfTcrCampaignWithUseCases</a></code>
+- <code title="post /v3/profiles/{profileId}/campaigns">client.profiles.campaigns.<a href="./src/sent_dm/resources/profiles/campaigns.py">create</a>(profile_id, \*\*<a href="src/sent_dm/types/profiles/campaign_create_params.py">params</a>) -> <a href="./src/sent_dm/types/profiles/campaign_create_response.py">CampaignCreateResponse</a></code>
+- <code title="put /v3/profiles/{profileId}/campaigns/{campaignId}">client.profiles.campaigns.<a href="./src/sent_dm/resources/profiles/campaigns.py">update</a>(campaign_id, \*, profile_id, \*\*<a href="src/sent_dm/types/profiles/campaign_update_params.py">params</a>) -> <a href="./src/sent_dm/types/profiles/campaign_update_response.py">CampaignUpdateResponse</a></code>
 - <code title="get /v3/profiles/{profileId}/campaigns">client.profiles.campaigns.<a href="./src/sent_dm/resources/profiles/campaigns.py">list</a>(profile_id) -> <a href="./src/sent_dm/types/profiles/campaign_list_response.py">CampaignListResponse</a></code>
 - <code title="delete /v3/profiles/{profileId}/campaigns/{campaignId}">client.profiles.campaigns.<a href="./src/sent_dm/resources/profiles/campaigns.py">delete</a>(campaign_id, \*, profile_id, \*\*<a href="src/sent_dm/types/profiles/campaign_delete_params.py">params</a>) -> None</code>
 

src/sent_dm/resources/messages.py

@@ -144,7 +144,10 @@ def send(
         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. Account-level preconditions such as
+        insufficient balance do not reject the request: the send is accepted with 202
+        and the affected messages are reported as BLOCKED on GET /messages/{id} and the
+        message status webhook.
 
         Args:
           channel: Channels to broadcast on, e.g. ["whatsapp", "sms"]. Each channel produces a
@@ -316,7 +319,10 @@ async def send(
         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. Account-level preconditions such as
+        insufficient balance do not reject the request: the send is accepted with 202
+        and the affected messages are reported as BLOCKED on GET /messages/{id} and the
+        message status webhook.
 
         Args:
           channel: Channels to broadcast on, e.g. ["whatsapp", "sms"]. Each channel produces a

src/sent_dm/resources/profiles/campaigns.py

@@ -18,7 +18,8 @@
 from ...types.profiles import campaign_create_params, campaign_delete_params, campaign_update_params
 from ...types.profiles.campaign_data_param import CampaignDataParam
 from ...types.profiles.campaign_list_response import CampaignListResponse
-from ...types.profiles.api_response_of_tcr_campaign_with_use_cases import APIResponseOfTcrCampaignWithUseCases
+from ...types.profiles.campaign_create_response import CampaignCreateResponse
+from ...types.profiles.campaign_update_response import CampaignUpdateResponse
 
 __all__ = ["CampaignsResource", "AsyncCampaignsResource"]
 
@@ -59,7 +60,7 @@ def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> APIResponseOfTcrCampaignWithUseCases:
+    ) -> CampaignCreateResponse:
         """Creates a new campaign scoped under the brand of the specified profile.
 
         Each
@@ -102,7 +103,7 @@ def create(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIResponseOfTcrCampaignWithUseCases,
+            cast_to=CampaignCreateResponse,
         )
 
     def update(
@@ -120,7 +121,7 @@ def update(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> APIResponseOfTcrCampaignWithUseCases:
+    ) -> CampaignUpdateResponse:
         """Updates an existing campaign under the brand of the specified profile.
 
         Cannot
@@ -167,7 +168,7 @@ def update(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIResponseOfTcrCampaignWithUseCases,
+            cast_to=CampaignUpdateResponse,
         )
 
     def list(
@@ -291,7 +292,7 @@ async def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> APIResponseOfTcrCampaignWithUseCases:
+    ) -> CampaignCreateResponse:
         """Creates a new campaign scoped under the brand of the specified profile.
 
         Each
@@ -334,7 +335,7 @@ async def create(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIResponseOfTcrCampaignWithUseCases,
+            cast_to=CampaignCreateResponse,
         )
 
     async def update(
@@ -352,7 +353,7 @@ async def update(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> APIResponseOfTcrCampaignWithUseCases:
+    ) -> CampaignUpdateResponse:
         """Updates an existing campaign under the brand of the specified profile.
 
         Cannot
@@ -399,7 +400,7 @@ async def update(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=APIResponseOfTcrCampaignWithUseCases,
+            cast_to=CampaignUpdateResponse,
         )
 
     async def list(

src/sent_dm/resources/profiles/profiles.py

@@ -366,7 +366,7 @@ def update(
 
           sending_phone_number: Direct phone number for SMS sending (optional)
 
-          sending_phone_number_profile_id: Reference to another profile to use for SMS/Telnyx configuration (optional)
+          sending_phone_number_profile_id: Reference to another profile to use for SMS configuration (optional)
 
           sending_whatsapp_number_profile_id: Reference to another profile to use for WhatsApp configuration (optional)
 
@@ -521,26 +521,38 @@ def complete(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ProfileCompleteResponse:
-        """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
 
         Args:
           web_hook_url: Webhook URL to call when profile completion finishes (success or failure)
@@ -908,7 +920,7 @@ async def update(
 
           sending_phone_number: Direct phone number for SMS sending (optional)
 
-          sending_phone_number_profile_id: Reference to another profile to use for SMS/Telnyx configuration (optional)
+          sending_phone_number_profile_id: Reference to another profile to use for SMS configuration (optional)
 
           sending_whatsapp_number_profile_id: Reference to another profile to use for WhatsApp configuration (optional)
 
@@ -1063,26 +1075,38 @@ async def complete(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> ProfileCompleteResponse:
-        """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
 
         Args:
           web_hook_url: Webhook URL to call when profile completion finishes (success or failure)

src/sent_dm/types/message_send_response.py

@@ -38,10 +38,7 @@ class Data(BaseModel):
     """Per-recipient message results"""
 
     status: Optional[str] = None
-    """
-    Overall request status: "QUEUED" when the batch has been accepted and published
-    to Kafka.
-    """
+    """Overall request status: "QUEUED" when the batch has been accepted for delivery."""
 
     template_id: Optional[str] = None
     """Template ID that was used"""

src/sent_dm/types/profile_detail.py

@@ -69,9 +69,6 @@ class BrandCompliance(BaseModel):
     destination_countries: Optional[List[DestinationCountry]] = None
     """List of destination countries for messaging"""
 
-    expected_messaging_volume: Optional[str] = None
-    """Expected daily messaging volume"""
-
     is_tcr_application: Optional[bool] = None
     """Whether this is a TCR (Campaign Registry) application"""
 
@@ -216,7 +213,7 @@ class ProfileDetail(BaseModel):
     """Direct SMS phone number"""
 
     sending_phone_number_profile_id: Optional[str] = None
-    """Reference to another profile for SMS/Telnyx configuration"""
+    """Reference to another profile whose SMS configuration this profile uses"""
 
     sending_whatsapp_number_profile_id: Optional[str] = None
     """Reference to another profile for WhatsApp configuration"""

src/sent_dm/types/profile_update_params.py

@@ -80,7 +80,7 @@ class ProfileUpdateParams(TypedDict, total=False):
     """Direct phone number for SMS sending (optional)"""
 
     sending_phone_number_profile_id: Optional[str]
-    """Reference to another profile to use for SMS/Telnyx configuration (optional)"""
+    """Reference to another profile to use for SMS configuration (optional)"""
 
     sending_whatsapp_number_profile_id: Optional[str]
     """Reference to another profile to use for WhatsApp configuration (optional)"""

src/sent_dm/types/profiles/__init__.py

@@ -2,17 +2,14 @@
 
 from __future__ import annotations
 
-from .base_dto import BaseDto as BaseDto
 from .campaign_data_param import CampaignDataParam as CampaignDataParam
 from .messaging_use_case_us import MessagingUseCaseUs as MessagingUseCaseUs
 from .campaign_create_params import CampaignCreateParams as CampaignCreateParams
 from .campaign_delete_params import CampaignDeleteParams as CampaignDeleteParams
 from .campaign_list_response import CampaignListResponse as CampaignListResponse
 from .campaign_update_params import CampaignUpdateParams as CampaignUpdateParams
-from .tcr_campaign_with_use_cases import TcrCampaignWithUseCases as TcrCampaignWithUseCases
-from .api_response_of_tcr_campaign_with_use_cases import (
-    APIResponseOfTcrCampaignWithUseCases as APIResponseOfTcrCampaignWithUseCases,
-)
+from .campaign_create_response import CampaignCreateResponse as CampaignCreateResponse
+from .campaign_update_response import CampaignUpdateResponse as CampaignUpdateResponse
 from .sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data_param import (
     SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseDataParam as SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseDataParam,
 )