pingram-python 1.0.28__tar.gz → 1.0.29__tar.gz

{pingram_python-1.0.28/generated/pingram_python.egg-info → pingram_python-1.0.29}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pingram-python
-Version: 1.0.28
+Version: 1.0.29
 Summary: Official Python SDK for Pingram - Send notifications via Email, SMS, Push, In-App, and more
 Author: Pingram
 License: MIT

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.0.28"
+__version__ = "1.0.29"
 
 # Define package exports
 __all__ = [

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/api_client.py

@@ -91,7 +91,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'pingram-python/1.0.28'
+        self.user_agent = 'pingram-python/1.0.29'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/configuration.py

@@ -551,7 +551,7 @@ conf = pingram.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0.0\n"\
-               "SDK Package Version: 1.0.28".\
+               "SDK Package Version: 1.0.29".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/models/account_get_response.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing import Optional, Set
 from typing_extensions import Self
@@ -36,12 +36,14 @@ class AccountGetResponse(BaseModel):
     call_cap: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="callCap")
     billing_version: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="When omitted, defaults to LATEST_BILLING_VERSION.", alias="billingVersion")
     anniversary_date: StrictStr = Field(description="ISO date (YYYY-MM-DD) when the billing cycle resets.", alias="anniversaryDate")
-    allow_overage: StrictBool = Field(alias="allowOverage")
     created_at: StrictStr = Field(alias="createdAt")
     updated_at: StrictStr = Field(alias="updatedAt")
     status: Optional[StrictStr] = None
     subscription_status: Optional[StrictStr] = Field(default=None, alias="subscriptionStatus")
-    __properties: ClassVar[List[str]] = ["accountId", "accountType", "creator", "name", "messagesCap", "costCap", "smsCap", "callCap", "billingVersion", "anniversaryDate", "allowOverage", "createdAt", "updatedAt", "status", "subscriptionStatus"]
+    pending_downgrade_effective_date: Optional[StrictStr] = Field(default=None, alias="pendingDowngradeEffectiveDate")
+    pending_downgrade_cost_cap: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="pendingDowngradeCostCap")
+    pending_downgrade_account_type: Optional[StrictStr] = Field(default=None, alias="pendingDowngradeAccountType")
+    __properties: ClassVar[List[str]] = ["accountId", "accountType", "creator", "name", "messagesCap", "costCap", "smsCap", "callCap", "billingVersion", "anniversaryDate", "createdAt", "updatedAt", "status", "subscriptionStatus", "pendingDowngradeEffectiveDate", "pendingDowngradeCostCap", "pendingDowngradeAccountType"]
 
     @field_validator('account_type')
     def account_type_validate_enum(cls, value):
@@ -80,6 +82,16 @@ class AccountGetResponse(BaseModel):
             raise ValueError("must be one of enum values ('active', 'canceled', 'past_due', 'paused')")
         return value
 
+    @field_validator('pending_downgrade_account_type')
+    def pending_downgrade_account_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['free']):
+            raise ValueError("must be one of enum values ('free')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -146,11 +158,13 @@ class AccountGetResponse(BaseModel):
             "callCap": obj.get("callCap"),
             "billingVersion": obj.get("billingVersion"),
             "anniversaryDate": obj.get("anniversaryDate"),
-            "allowOverage": obj.get("allowOverage"),
             "createdAt": obj.get("createdAt"),
             "updatedAt": obj.get("updatedAt"),
             "status": obj.get("status"),
-            "subscriptionStatus": obj.get("subscriptionStatus")
+            "subscriptionStatus": obj.get("subscriptionStatus"),
+            "pendingDowngradeEffectiveDate": obj.get("pendingDowngradeEffectiveDate"),
+            "pendingDowngradeCostCap": obj.get("pendingDowngradeCostCap"),
+            "pendingDowngradeAccountType": obj.get("pendingDowngradeAccountType")
         })
         return _obj
 

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/models/billing_post_response_body.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing import Optional, Set
 from typing_extensions import Self
@@ -36,14 +36,16 @@ class BillingPostResponseBody(BaseModel):
     call_cap: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="callCap")
     billing_version: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="When omitted, defaults to LATEST_BILLING_VERSION.", alias="billingVersion")
     anniversary_date: StrictStr = Field(description="ISO date (YYYY-MM-DD) when the billing cycle resets.", alias="anniversaryDate")
-    allow_overage: StrictBool = Field(alias="allowOverage")
     created_at: StrictStr = Field(alias="createdAt")
     updated_at: StrictStr = Field(alias="updatedAt")
     status: Optional[StrictStr] = None
     subscription_status: Optional[StrictStr] = Field(default=None, alias="subscriptionStatus")
+    pending_downgrade_effective_date: Optional[StrictStr] = Field(default=None, alias="pendingDowngradeEffectiveDate")
+    pending_downgrade_cost_cap: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="pendingDowngradeCostCap")
+    pending_downgrade_account_type: Optional[StrictStr] = Field(default=None, alias="pendingDowngradeAccountType")
     session_id: Optional[StrictStr] = Field(default=None, alias="sessionId")
     url: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["accountId", "accountType", "creator", "name", "messagesCap", "costCap", "smsCap", "callCap", "billingVersion", "anniversaryDate", "allowOverage", "createdAt", "updatedAt", "status", "subscriptionStatus", "sessionId", "url"]
+    __properties: ClassVar[List[str]] = ["accountId", "accountType", "creator", "name", "messagesCap", "costCap", "smsCap", "callCap", "billingVersion", "anniversaryDate", "createdAt", "updatedAt", "status", "subscriptionStatus", "pendingDowngradeEffectiveDate", "pendingDowngradeCostCap", "pendingDowngradeAccountType", "sessionId", "url"]
 
     @field_validator('account_type')
     def account_type_validate_enum(cls, value):
@@ -82,6 +84,16 @@ class BillingPostResponseBody(BaseModel):
             raise ValueError("must be one of enum values ('active', 'canceled', 'past_due', 'paused')")
         return value
 
+    @field_validator('pending_downgrade_account_type')
+    def pending_downgrade_account_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['free']):
+            raise ValueError("must be one of enum values ('free')")
+        return value
+
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
@@ -148,11 +160,13 @@ class BillingPostResponseBody(BaseModel):
             "callCap": obj.get("callCap"),
             "billingVersion": obj.get("billingVersion"),
             "anniversaryDate": obj.get("anniversaryDate"),
-            "allowOverage": obj.get("allowOverage"),
             "createdAt": obj.get("createdAt"),
             "updatedAt": obj.get("updatedAt"),
             "status": obj.get("status"),
             "subscriptionStatus": obj.get("subscriptionStatus"),
+            "pendingDowngradeEffectiveDate": obj.get("pendingDowngradeEffectiveDate"),
+            "pendingDowngradeCostCap": obj.get("pendingDowngradeCostCap"),
+            "pendingDowngradeAccountType": obj.get("pendingDowngradeAccountType"),
             "sessionId": obj.get("sessionId"),
             "url": obj.get("url")
         })

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/models/ten_dlc_brand_admin_update_request.py

@@ -28,19 +28,19 @@ class TenDlcBrandAdminUpdateRequest(BaseModel):
     """ # noqa: E501
     scenario_id: Optional[StrictStr] = Field(default=None, description="Who the 10DLC brand is registered for. - own_brand: personal or company project - client_brand: agency or contractor", alias="scenarioId")
     business_type: Optional[StrictStr] = Field(default=None, description="Legal entity type for a 10DLC brand. - PRIVATE_PROFIT: private for-profit (LLC, corp, etc.) - SOLE_PROPRIETOR: sole proprietorship - PUBLIC_PROFIT: publicly traded for-profit - NON_PROFIT: non-profit - GOVERNMENT: government", alias="businessType")
-    legal_name: Optional[StrictStr] = Field(default=None, alias="legalName")
-    display_name: Optional[StrictStr] = Field(default=None, description="Brand display name (marketing/DBA); defaults to legalName when omitted on legalName-only updates.", alias="displayName")
-    first_name: Optional[StrictStr] = Field(default=None, alias="firstName")
-    last_name: Optional[StrictStr] = Field(default=None, alias="lastName")
-    tax_id: Optional[StrictStr] = Field(default=None, description="For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier.", alias="taxId")
-    website: Optional[StrictStr] = None
-    country: Optional[StrictStr] = None
-    street: Optional[StrictStr] = None
-    city: Optional[StrictStr] = None
-    state: Optional[StrictStr] = None
-    postal_code: Optional[StrictStr] = Field(default=None, alias="postalCode")
-    compliance_contact_email: Optional[StrictStr] = Field(default=None, alias="complianceContactEmail")
-    compliance_contact_phone: Optional[StrictStr] = Field(default=None, alias="complianceContactPhone")
+    legal_name: Optional[StrictStr] = Field(default=None, description="Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName).", alias="legalName")
+    display_name: Optional[StrictStr] = Field(default=None, description="Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For SOLE_PROPRIETOR, this is the brand you send as — not the individual's legal name. Omit to keep the existing value. If you change legalName and omit displayName, displayName is reset to the new legalName.", alias="displayName")
+    first_name: Optional[StrictStr] = Field(default=None, description="Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.", alias="firstName")
+    last_name: Optional[StrictStr] = Field(default=None, description="Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.", alias="lastName")
+    tax_id: Optional[StrictStr] = Field(default=None, description="For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Required except when businessType is SOLE_PROPRIETOR.", alias="taxId")
+    website: Optional[StrictStr] = Field(default=None, description="Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms.")
+    country: Optional[StrictStr] = Field(default=None, description="ISO 3166-1 alpha-2 country of incorporation (for example US or CA).")
+    street: Optional[StrictStr] = Field(default=None, description="Street address that matches official tax registration.")
+    city: Optional[StrictStr] = Field(default=None, description="City that matches official tax registration.")
+    state: Optional[StrictStr] = Field(default=None, description="State (US) or province (CA) that matches official tax registration.")
+    postal_code: Optional[StrictStr] = Field(default=None, description="ZIP code (US) or postal code (CA) that matches official tax registration.", alias="postalCode")
+    compliance_contact_email: Optional[StrictStr] = Field(default=None, description="Email for the 10DLC compliance contact. Used for carrier and registration follow-up.", alias="complianceContactEmail")
+    compliance_contact_phone: Optional[StrictStr] = Field(default=None, description="Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country.", alias="complianceContactPhone")
     vertical: Optional[StrictStr] = Field(default=None, description="Industry vertical required before Pingram submits the brand to carriers.")
     entity_type: Optional[StrictStr] = Field(default=None, description="Legacy only when businessType is Other.", alias="entityType")
     brand_status: Optional[StrictStr] = Field(default=None, description="Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome", alias="brandStatus")

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/models/ten_dlc_brand_create_request.py

@@ -28,19 +28,20 @@ class TenDlcBrandCreateRequest(BaseModel):
     """ # noqa: E501
     scenario_id: StrictStr = Field(description="Who the 10DLC brand is registered for. - own_brand: personal or company project - client_brand: agency or contractor", alias="scenarioId")
     business_type: StrictStr = Field(description="Legal entity type for a 10DLC brand. - PRIVATE_PROFIT: private for-profit (LLC, corp, etc.) - SOLE_PROPRIETOR: sole proprietorship - PUBLIC_PROFIT: publicly traded for-profit - NON_PROFIT: non-profit - GOVERNMENT: government", alias="businessType")
-    legal_name: StrictStr = Field(alias="legalName")
-    first_name: Optional[StrictStr] = Field(default=None, description="Required when businessType is SOLE_PROPRIETOR.", alias="firstName")
-    last_name: Optional[StrictStr] = Field(default=None, description="Required when businessType is SOLE_PROPRIETOR.", alias="lastName")
+    legal_name: Optional[StrictStr] = Field(default=None, description="Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName).", alias="legalName")
+    display_name: StrictStr = Field(description="Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For companies with no DBA, use the same value as legalName. For SOLE_PROPRIETOR, this is the brand you send as — not the individual's legal name (set firstName and lastName for that). If the sole proprietor has no DBA, use first and last name.", alias="displayName")
+    first_name: Optional[StrictStr] = Field(default=None, description="Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.", alias="firstName")
+    last_name: Optional[StrictStr] = Field(default=None, description="Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.", alias="lastName")
     tax_id: Optional[StrictStr] = Field(default=None, description="For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Required except when businessType is SOLE_PROPRIETOR.", alias="taxId")
-    website: StrictStr
-    country: StrictStr
-    street: Optional[StrictStr] = None
-    city: Optional[StrictStr] = None
-    state: Optional[StrictStr] = None
-    postal_code: Optional[StrictStr] = Field(default=None, alias="postalCode")
-    compliance_contact_email: StrictStr = Field(alias="complianceContactEmail")
-    compliance_contact_phone: StrictStr = Field(alias="complianceContactPhone")
-    __properties: ClassVar[List[str]] = ["scenarioId", "businessType", "legalName", "firstName", "lastName", "taxId", "website", "country", "street", "city", "state", "postalCode", "complianceContactEmail", "complianceContactPhone"]
+    website: StrictStr = Field(description="Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms.")
+    country: StrictStr = Field(description="ISO 3166-1 alpha-2 country of incorporation (for example US or CA).")
+    street: StrictStr = Field(description="Street address that matches official tax registration.")
+    city: StrictStr = Field(description="City that matches official tax registration.")
+    state: StrictStr = Field(description="State (US) or province (CA) that matches official tax registration.")
+    postal_code: StrictStr = Field(description="ZIP code (US) or postal code (CA) that matches official tax registration.", alias="postalCode")
+    compliance_contact_email: StrictStr = Field(description="Email for the 10DLC compliance contact. Used for carrier and registration follow-up.", alias="complianceContactEmail")
+    compliance_contact_phone: StrictStr = Field(description="Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country.", alias="complianceContactPhone")
+    __properties: ClassVar[List[str]] = ["scenarioId", "businessType", "legalName", "displayName", "firstName", "lastName", "taxId", "website", "country", "street", "city", "state", "postalCode", "complianceContactEmail", "complianceContactPhone"]
 
     @field_validator('scenario_id')
     def scenario_id_validate_enum(cls, value):
@@ -110,6 +111,7 @@ class TenDlcBrandCreateRequest(BaseModel):
             "scenarioId": obj.get("scenarioId"),
             "businessType": obj.get("businessType"),
             "legalName": obj.get("legalName"),
+            "displayName": obj.get("displayName"),
             "firstName": obj.get("firstName"),
             "lastName": obj.get("lastName"),
             "taxId": obj.get("taxId"),

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/models/ten_dlc_brand_registration.py

@@ -29,20 +29,20 @@ class TenDlcBrandRegistration(BaseModel):
     account_id: StrictStr = Field(alias="accountId")
     scenario_id: StrictStr = Field(alias="scenarioId")
     business_type: StrictStr = Field(alias="businessType")
-    legal_name: StrictStr = Field(alias="legalName")
-    display_name: Optional[StrictStr] = Field(default=None, description="Brand display name (marketing/DBA); defaults to legalName on customer submit.", alias="displayName")
-    first_name: Optional[StrictStr] = Field(default=None, alias="firstName")
-    last_name: Optional[StrictStr] = Field(default=None, alias="lastName")
-    tax_id: Optional[StrictStr] = Field(default=None, alias="taxId")
-    website: StrictStr
-    country: StrictStr
-    street: Optional[StrictStr] = None
-    city: Optional[StrictStr] = None
-    state: Optional[StrictStr] = None
-    postal_code: Optional[StrictStr] = Field(default=None, alias="postalCode")
+    legal_name: StrictStr = Field(description="Official registered legal business name. For SOLE_PROPRIETOR, may be a DBA or trade name.", alias="legalName")
+    display_name: Optional[StrictStr] = Field(default=None, description="Public brand name shown to recipients and carriers.", alias="displayName")
+    first_name: Optional[StrictStr] = Field(default=None, description="Legal first name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.", alias="firstName")
+    last_name: Optional[StrictStr] = Field(default=None, description="Legal last name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.", alias="lastName")
+    tax_id: Optional[StrictStr] = Field(default=None, description="For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Omitted when businessType is SOLE_PROPRIETOR.", alias="taxId")
+    website: StrictStr = Field(description="Public website for the brand.")
+    country: StrictStr = Field(description="ISO 3166-1 alpha-2 country of incorporation (for example US or CA).")
+    street: Optional[StrictStr] = Field(default=None, description="Street address that matches official tax registration.")
+    city: Optional[StrictStr] = Field(default=None, description="City that matches official tax registration.")
+    state: Optional[StrictStr] = Field(default=None, description="State (US) or province (CA) that matches official tax registration.")
+    postal_code: Optional[StrictStr] = Field(default=None, description="ZIP code (US) or postal code (CA) that matches official tax registration.", alias="postalCode")
     full_address: Optional[StrictStr] = Field(default=None, description="Legacy records only; new submissions use structured address fields.", alias="fullAddress")
-    compliance_contact_email: StrictStr = Field(alias="complianceContactEmail")
-    compliance_contact_phone: StrictStr = Field(alias="complianceContactPhone")
+    compliance_contact_email: StrictStr = Field(description="Email for the 10DLC compliance contact.", alias="complianceContactEmail")
+    compliance_contact_phone: StrictStr = Field(description="Phone number for the 10DLC compliance contact.", alias="complianceContactPhone")
     brand_status: StrictStr = Field(description="Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome", alias="brandStatus")
     campaign_status: StrictStr = Field(description="Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome", alias="campaignStatus")
     created_at: StrictStr = Field(alias="createdAt")

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/models/ten_dlc_brand_registration_details.py

@@ -29,20 +29,20 @@ class TenDlcBrandRegistrationDetails(BaseModel):
     account_id: StrictStr = Field(alias="accountId")
     scenario_id: StrictStr = Field(alias="scenarioId")
     business_type: StrictStr = Field(alias="businessType")
-    legal_name: StrictStr = Field(alias="legalName")
-    display_name: Optional[StrictStr] = Field(default=None, description="Brand display name (marketing/DBA); defaults to legalName on customer submit.", alias="displayName")
-    first_name: Optional[StrictStr] = Field(default=None, alias="firstName")
-    last_name: Optional[StrictStr] = Field(default=None, alias="lastName")
-    tax_id: Optional[StrictStr] = Field(default=None, alias="taxId")
-    website: StrictStr
-    country: StrictStr
-    street: Optional[StrictStr] = None
-    city: Optional[StrictStr] = None
-    state: Optional[StrictStr] = None
-    postal_code: Optional[StrictStr] = Field(default=None, alias="postalCode")
+    legal_name: StrictStr = Field(description="Official registered legal business name. For SOLE_PROPRIETOR, may be a DBA or trade name.", alias="legalName")
+    display_name: Optional[StrictStr] = Field(default=None, description="Public brand name shown to recipients and carriers.", alias="displayName")
+    first_name: Optional[StrictStr] = Field(default=None, description="Legal first name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.", alias="firstName")
+    last_name: Optional[StrictStr] = Field(default=None, description="Legal last name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.", alias="lastName")
+    tax_id: Optional[StrictStr] = Field(default=None, description="For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Omitted when businessType is SOLE_PROPRIETOR.", alias="taxId")
+    website: StrictStr = Field(description="Public website for the brand.")
+    country: StrictStr = Field(description="ISO 3166-1 alpha-2 country of incorporation (for example US or CA).")
+    street: Optional[StrictStr] = Field(default=None, description="Street address that matches official tax registration.")
+    city: Optional[StrictStr] = Field(default=None, description="City that matches official tax registration.")
+    state: Optional[StrictStr] = Field(default=None, description="State (US) or province (CA) that matches official tax registration.")
+    postal_code: Optional[StrictStr] = Field(default=None, description="ZIP code (US) or postal code (CA) that matches official tax registration.", alias="postalCode")
     full_address: Optional[StrictStr] = Field(default=None, description="Legacy records only; new submissions use structured address fields.", alias="fullAddress")
-    compliance_contact_email: StrictStr = Field(alias="complianceContactEmail")
-    compliance_contact_phone: StrictStr = Field(alias="complianceContactPhone")
+    compliance_contact_email: StrictStr = Field(description="Email for the 10DLC compliance contact.", alias="complianceContactEmail")
+    compliance_contact_phone: StrictStr = Field(description="Phone number for the 10DLC compliance contact.", alias="complianceContactPhone")
     brand_status: StrictStr = Field(description="Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome", alias="brandStatus")
     campaign_status: StrictStr = Field(description="Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome", alias="campaignStatus")
     created_at: StrictStr = Field(alias="createdAt")

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/models/ten_dlc_brand_update_request.py

@@ -28,19 +28,19 @@ class TenDlcBrandUpdateRequest(BaseModel):
     """ # noqa: E501
     scenario_id: Optional[StrictStr] = Field(default=None, description="Who the 10DLC brand is registered for. - own_brand: personal or company project - client_brand: agency or contractor", alias="scenarioId")
     business_type: Optional[StrictStr] = Field(default=None, description="Legal entity type for a 10DLC brand. - PRIVATE_PROFIT: private for-profit (LLC, corp, etc.) - SOLE_PROPRIETOR: sole proprietorship - PUBLIC_PROFIT: publicly traded for-profit - NON_PROFIT: non-profit - GOVERNMENT: government", alias="businessType")
-    legal_name: Optional[StrictStr] = Field(default=None, alias="legalName")
-    display_name: Optional[StrictStr] = Field(default=None, description="Brand display name (marketing/DBA); defaults to legalName when omitted on legalName-only updates.", alias="displayName")
-    first_name: Optional[StrictStr] = Field(default=None, alias="firstName")
-    last_name: Optional[StrictStr] = Field(default=None, alias="lastName")
-    tax_id: Optional[StrictStr] = Field(default=None, description="For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier.", alias="taxId")
-    website: Optional[StrictStr] = None
-    country: Optional[StrictStr] = None
-    street: Optional[StrictStr] = None
-    city: Optional[StrictStr] = None
-    state: Optional[StrictStr] = None
-    postal_code: Optional[StrictStr] = Field(default=None, alias="postalCode")
-    compliance_contact_email: Optional[StrictStr] = Field(default=None, alias="complianceContactEmail")
-    compliance_contact_phone: Optional[StrictStr] = Field(default=None, alias="complianceContactPhone")
+    legal_name: Optional[StrictStr] = Field(default=None, description="Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName).", alias="legalName")
+    display_name: Optional[StrictStr] = Field(default=None, description="Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For SOLE_PROPRIETOR, this is the brand you send as — not the individual's legal name. Omit to keep the existing value. If you change legalName and omit displayName, displayName is reset to the new legalName.", alias="displayName")
+    first_name: Optional[StrictStr] = Field(default=None, description="Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.", alias="firstName")
+    last_name: Optional[StrictStr] = Field(default=None, description="Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.", alias="lastName")
+    tax_id: Optional[StrictStr] = Field(default=None, description="For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Required except when businessType is SOLE_PROPRIETOR.", alias="taxId")
+    website: Optional[StrictStr] = Field(default=None, description="Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms.")
+    country: Optional[StrictStr] = Field(default=None, description="ISO 3166-1 alpha-2 country of incorporation (for example US or CA).")
+    street: Optional[StrictStr] = Field(default=None, description="Street address that matches official tax registration.")
+    city: Optional[StrictStr] = Field(default=None, description="City that matches official tax registration.")
+    state: Optional[StrictStr] = Field(default=None, description="State (US) or province (CA) that matches official tax registration.")
+    postal_code: Optional[StrictStr] = Field(default=None, description="ZIP code (US) or postal code (CA) that matches official tax registration.", alias="postalCode")
+    compliance_contact_email: Optional[StrictStr] = Field(default=None, description="Email for the 10DLC compliance contact. Used for carrier and registration follow-up.", alias="complianceContactEmail")
+    compliance_contact_phone: Optional[StrictStr] = Field(default=None, description="Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country.", alias="complianceContactPhone")
     __properties: ClassVar[List[str]] = ["scenarioId", "businessType", "legalName", "displayName", "firstName", "lastName", "taxId", "website", "country", "street", "city", "state", "postalCode", "complianceContactEmail", "complianceContactPhone"]
 
     @field_validator('scenario_id')

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/models/ten_dlc_campaign_admin_update_request.py

@@ -26,26 +26,26 @@ class TenDlcCampaignAdminUpdateRequest(BaseModel):
     """
     Request body for PATCH /registrations/us/10dlc/campaign/admin
     """ # noqa: E501
-    campaign_description: Optional[StrictStr] = Field(default=None, alias="campaignDescription")
-    campaign_sample1: Optional[StrictStr] = Field(default=None, alias="campaignSample1")
-    campaign_sample2: Optional[StrictStr] = Field(default=None, alias="campaignSample2")
-    campaign_sample3: Optional[StrictStr] = Field(default=None, alias="campaignSample3")
-    campaign_sample4: Optional[StrictStr] = Field(default=None, alias="campaignSample4")
-    campaign_message_flow: Optional[StrictStr] = Field(default=None, alias="campaignMessageFlow")
-    campaign_optin_keywords: Optional[StrictStr] = Field(default=None, alias="campaignOptinKeywords")
-    campaign_optin_message: Optional[StrictStr] = Field(default=None, alias="campaignOptinMessage")
-    campaign_optout_keywords: Optional[StrictStr] = Field(default=None, alias="campaignOptoutKeywords")
-    campaign_optout_message: Optional[StrictStr] = Field(default=None, alias="campaignOptoutMessage")
-    campaign_help_keywords: Optional[StrictStr] = Field(default=None, alias="campaignHelpKeywords")
-    campaign_help_message: Optional[StrictStr] = Field(default=None, alias="campaignHelpMessage")
-    campaign_embedded_link: Optional[StrictBool] = Field(default=None, alias="campaignEmbeddedLink")
-    campaign_embedded_link_url: Optional[StrictStr] = Field(default=None, alias="campaignEmbeddedLinkUrl")
-    campaign_embedded_phone: Optional[StrictBool] = Field(default=None, alias="campaignEmbeddedPhone")
-    campaign_age_gated: Optional[StrictBool] = Field(default=None, alias="campaignAgeGated")
-    campaign_direct_lending: Optional[StrictBool] = Field(default=None, alias="campaignDirectLending")
-    campaign_privacy_policy_link: Optional[StrictStr] = Field(default=None, alias="campaignPrivacyPolicyLink")
-    campaign_terms_and_conditions_link: Optional[StrictStr] = Field(default=None, alias="campaignTermsAndConditionsLink")
-    campaign_usecase: Optional[StrictStr] = Field(default=None, alias="campaignUsecase")
+    campaign_description: Optional[StrictStr] = Field(default=None, description="Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.", alias="campaignDescription")
+    campaign_sample1: Optional[StrictStr] = Field(default=None, description="Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.", alias="campaignSample1")
+    campaign_sample2: Optional[StrictStr] = Field(default=None, description="Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.", alias="campaignSample2")
+    campaign_sample3: Optional[StrictStr] = Field(default=None, description="Optional third example SMS.", alias="campaignSample3")
+    campaign_sample4: Optional[StrictStr] = Field(default=None, description="Optional fourth example SMS.", alias="campaignSample4")
+    campaign_message_flow: Optional[StrictStr] = Field(default=None, description="How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.", alias="campaignMessageFlow")
+    campaign_optin_keywords: Optional[StrictStr] = Field(default=None, description="Extra opt-in keywords as a comma-separated list. START is always included.", alias="campaignOptinKeywords")
+    campaign_optin_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.", alias="campaignOptinMessage")
+    campaign_optout_keywords: Optional[StrictStr] = Field(default=None, description="Extra opt-out keywords as a comma-separated list. STOP is always included.", alias="campaignOptoutKeywords")
+    campaign_optout_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.", alias="campaignOptoutMessage")
+    campaign_help_keywords: Optional[StrictStr] = Field(default=None, description="Extra help keywords as a comma-separated list. HELP is always included.", alias="campaignHelpKeywords")
+    campaign_help_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).", alias="campaignHelpMessage")
+    campaign_embedded_link: Optional[StrictBool] = Field(default=None, description="Whether campaign messages include URLs.", alias="campaignEmbeddedLink")
+    campaign_embedded_link_url: Optional[StrictStr] = Field(default=None, description="Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.", alias="campaignEmbeddedLinkUrl")
+    campaign_embedded_phone: Optional[StrictBool] = Field(default=None, description="Whether campaign messages include phone numbers.", alias="campaignEmbeddedPhone")
+    campaign_age_gated: Optional[StrictBool] = Field(default=None, description="Whether campaign content is age-restricted (18+).", alias="campaignAgeGated")
+    campaign_direct_lending: Optional[StrictBool] = Field(default=None, description="Whether the campaign relates to direct lending or loan products.", alias="campaignDirectLending")
+    campaign_privacy_policy_link: Optional[StrictStr] = Field(default=None, description="Public URL of the privacy policy that covers this SMS program.", alias="campaignPrivacyPolicyLink")
+    campaign_terms_and_conditions_link: Optional[StrictStr] = Field(default=None, description="Public URL of the terms and conditions that cover this SMS program.", alias="campaignTermsAndConditionsLink")
+    campaign_usecase: Optional[StrictStr] = Field(default=None, description="10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.", alias="campaignUsecase")
     campaign_status: Optional[StrictStr] = Field(default=None, description="Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome", alias="campaignStatus")
     __properties: ClassVar[List[str]] = ["campaignDescription", "campaignSample1", "campaignSample2", "campaignSample3", "campaignSample4", "campaignMessageFlow", "campaignOptinKeywords", "campaignOptinMessage", "campaignOptoutKeywords", "campaignOptoutMessage", "campaignHelpKeywords", "campaignHelpMessage", "campaignEmbeddedLink", "campaignEmbeddedLinkUrl", "campaignEmbeddedPhone", "campaignAgeGated", "campaignDirectLending", "campaignPrivacyPolicyLink", "campaignTermsAndConditionsLink", "campaignUsecase", "campaignStatus"]
 

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/models/ten_dlc_campaign_registration.py

@@ -28,26 +28,26 @@ class TenDlcCampaignRegistration(BaseModel):
     """ # noqa: E501
     account_id: StrictStr = Field(alias="accountId")
     campaign_status: StrictStr = Field(description="Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome", alias="campaignStatus")
-    campaign_description: Optional[StrictStr] = Field(default=None, alias="campaignDescription")
-    campaign_sample1: Optional[StrictStr] = Field(default=None, alias="campaignSample1")
-    campaign_sample2: Optional[StrictStr] = Field(default=None, alias="campaignSample2")
-    campaign_sample3: Optional[StrictStr] = Field(default=None, alias="campaignSample3")
-    campaign_sample4: Optional[StrictStr] = Field(default=None, alias="campaignSample4")
-    campaign_message_flow: Optional[StrictStr] = Field(default=None, alias="campaignMessageFlow")
-    campaign_optin_keywords: Optional[StrictStr] = Field(default=None, alias="campaignOptinKeywords")
-    campaign_optin_message: Optional[StrictStr] = Field(default=None, alias="campaignOptinMessage")
-    campaign_optout_keywords: Optional[StrictStr] = Field(default=None, alias="campaignOptoutKeywords")
-    campaign_optout_message: Optional[StrictStr] = Field(default=None, alias="campaignOptoutMessage")
-    campaign_help_keywords: Optional[StrictStr] = Field(default=None, alias="campaignHelpKeywords")
-    campaign_help_message: Optional[StrictStr] = Field(default=None, alias="campaignHelpMessage")
-    campaign_embedded_link: Optional[StrictBool] = Field(default=None, alias="campaignEmbeddedLink")
-    campaign_embedded_link_url: Optional[StrictStr] = Field(default=None, alias="campaignEmbeddedLinkUrl")
-    campaign_embedded_phone: Optional[StrictBool] = Field(default=None, alias="campaignEmbeddedPhone")
-    campaign_age_gated: Optional[StrictBool] = Field(default=None, alias="campaignAgeGated")
-    campaign_direct_lending: Optional[StrictBool] = Field(default=None, alias="campaignDirectLending")
-    campaign_privacy_policy_link: Optional[StrictStr] = Field(default=None, alias="campaignPrivacyPolicyLink")
-    campaign_terms_and_conditions_link: Optional[StrictStr] = Field(default=None, alias="campaignTermsAndConditionsLink")
-    campaign_usecase: Optional[StrictStr] = Field(default=None, alias="campaignUsecase")
+    campaign_description: Optional[StrictStr] = Field(default=None, description="Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.", alias="campaignDescription")
+    campaign_sample1: Optional[StrictStr] = Field(default=None, description="Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.", alias="campaignSample1")
+    campaign_sample2: Optional[StrictStr] = Field(default=None, description="Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.", alias="campaignSample2")
+    campaign_sample3: Optional[StrictStr] = Field(default=None, description="Optional third example SMS.", alias="campaignSample3")
+    campaign_sample4: Optional[StrictStr] = Field(default=None, description="Optional fourth example SMS.", alias="campaignSample4")
+    campaign_message_flow: Optional[StrictStr] = Field(default=None, description="How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.", alias="campaignMessageFlow")
+    campaign_optin_keywords: Optional[StrictStr] = Field(default=None, description="Extra opt-in keywords as a comma-separated list. START is always included.", alias="campaignOptinKeywords")
+    campaign_optin_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.", alias="campaignOptinMessage")
+    campaign_optout_keywords: Optional[StrictStr] = Field(default=None, description="Extra opt-out keywords as a comma-separated list. STOP is always included.", alias="campaignOptoutKeywords")
+    campaign_optout_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.", alias="campaignOptoutMessage")
+    campaign_help_keywords: Optional[StrictStr] = Field(default=None, description="Extra help keywords as a comma-separated list. HELP is always included.", alias="campaignHelpKeywords")
+    campaign_help_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).", alias="campaignHelpMessage")
+    campaign_embedded_link: Optional[StrictBool] = Field(default=None, description="Whether campaign messages include URLs.", alias="campaignEmbeddedLink")
+    campaign_embedded_link_url: Optional[StrictStr] = Field(default=None, description="Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.", alias="campaignEmbeddedLinkUrl")
+    campaign_embedded_phone: Optional[StrictBool] = Field(default=None, description="Whether campaign messages include phone numbers.", alias="campaignEmbeddedPhone")
+    campaign_age_gated: Optional[StrictBool] = Field(default=None, description="Whether campaign content is age-restricted (18+).", alias="campaignAgeGated")
+    campaign_direct_lending: Optional[StrictBool] = Field(default=None, description="Whether the campaign relates to direct lending or loan products.", alias="campaignDirectLending")
+    campaign_privacy_policy_link: Optional[StrictStr] = Field(default=None, description="Public URL of the privacy policy that covers this SMS program.", alias="campaignPrivacyPolicyLink")
+    campaign_terms_and_conditions_link: Optional[StrictStr] = Field(default=None, description="Public URL of the terms and conditions that cover this SMS program.", alias="campaignTermsAndConditionsLink")
+    campaign_usecase: Optional[StrictStr] = Field(default=None, description="10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.", alias="campaignUsecase")
     created_at: StrictStr = Field(alias="createdAt")
     updated_at: StrictStr = Field(alias="updatedAt")
     __properties: ClassVar[List[str]] = ["accountId", "campaignStatus", "campaignDescription", "campaignSample1", "campaignSample2", "campaignSample3", "campaignSample4", "campaignMessageFlow", "campaignOptinKeywords", "campaignOptinMessage", "campaignOptoutKeywords", "campaignOptoutMessage", "campaignHelpKeywords", "campaignHelpMessage", "campaignEmbeddedLink", "campaignEmbeddedLinkUrl", "campaignEmbeddedPhone", "campaignAgeGated", "campaignDirectLending", "campaignPrivacyPolicyLink", "campaignTermsAndConditionsLink", "campaignUsecase", "createdAt", "updatedAt"]

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/models/ten_dlc_campaign_registration_details.py

@@ -28,26 +28,26 @@ class TenDlcCampaignRegistrationDetails(BaseModel):
     """ # noqa: E501
     account_id: StrictStr = Field(alias="accountId")
     campaign_status: StrictStr = Field(description="Pingram-side 10DLC registration workflow status (brand or campaign). - not_started: no customer submission yet - pending_review: customer submitted; Pingram has not submitted to carriers - in_progress: submitted for carrier review - approved | rejected | info_needed: review outcome", alias="campaignStatus")
-    campaign_description: Optional[StrictStr] = Field(default=None, alias="campaignDescription")
-    campaign_sample1: Optional[StrictStr] = Field(default=None, alias="campaignSample1")
-    campaign_sample2: Optional[StrictStr] = Field(default=None, alias="campaignSample2")
-    campaign_sample3: Optional[StrictStr] = Field(default=None, alias="campaignSample3")
-    campaign_sample4: Optional[StrictStr] = Field(default=None, alias="campaignSample4")
-    campaign_message_flow: Optional[StrictStr] = Field(default=None, alias="campaignMessageFlow")
-    campaign_optin_keywords: Optional[StrictStr] = Field(default=None, alias="campaignOptinKeywords")
-    campaign_optin_message: Optional[StrictStr] = Field(default=None, alias="campaignOptinMessage")
-    campaign_optout_keywords: Optional[StrictStr] = Field(default=None, alias="campaignOptoutKeywords")
-    campaign_optout_message: Optional[StrictStr] = Field(default=None, alias="campaignOptoutMessage")
-    campaign_help_keywords: Optional[StrictStr] = Field(default=None, alias="campaignHelpKeywords")
-    campaign_help_message: Optional[StrictStr] = Field(default=None, alias="campaignHelpMessage")
-    campaign_embedded_link: Optional[StrictBool] = Field(default=None, alias="campaignEmbeddedLink")
-    campaign_embedded_link_url: Optional[StrictStr] = Field(default=None, alias="campaignEmbeddedLinkUrl")
-    campaign_embedded_phone: Optional[StrictBool] = Field(default=None, alias="campaignEmbeddedPhone")
-    campaign_age_gated: Optional[StrictBool] = Field(default=None, alias="campaignAgeGated")
-    campaign_direct_lending: Optional[StrictBool] = Field(default=None, alias="campaignDirectLending")
-    campaign_privacy_policy_link: Optional[StrictStr] = Field(default=None, alias="campaignPrivacyPolicyLink")
-    campaign_terms_and_conditions_link: Optional[StrictStr] = Field(default=None, alias="campaignTermsAndConditionsLink")
-    campaign_usecase: Optional[StrictStr] = Field(default=None, alias="campaignUsecase")
+    campaign_description: Optional[StrictStr] = Field(default=None, description="Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.", alias="campaignDescription")
+    campaign_sample1: Optional[StrictStr] = Field(default=None, description="Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.", alias="campaignSample1")
+    campaign_sample2: Optional[StrictStr] = Field(default=None, description="Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.", alias="campaignSample2")
+    campaign_sample3: Optional[StrictStr] = Field(default=None, description="Optional third example SMS.", alias="campaignSample3")
+    campaign_sample4: Optional[StrictStr] = Field(default=None, description="Optional fourth example SMS.", alias="campaignSample4")
+    campaign_message_flow: Optional[StrictStr] = Field(default=None, description="How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.", alias="campaignMessageFlow")
+    campaign_optin_keywords: Optional[StrictStr] = Field(default=None, description="Extra opt-in keywords as a comma-separated list. START is always included.", alias="campaignOptinKeywords")
+    campaign_optin_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.", alias="campaignOptinMessage")
+    campaign_optout_keywords: Optional[StrictStr] = Field(default=None, description="Extra opt-out keywords as a comma-separated list. STOP is always included.", alias="campaignOptoutKeywords")
+    campaign_optout_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.", alias="campaignOptoutMessage")
+    campaign_help_keywords: Optional[StrictStr] = Field(default=None, description="Extra help keywords as a comma-separated list. HELP is always included.", alias="campaignHelpKeywords")
+    campaign_help_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).", alias="campaignHelpMessage")
+    campaign_embedded_link: Optional[StrictBool] = Field(default=None, description="Whether campaign messages include URLs.", alias="campaignEmbeddedLink")
+    campaign_embedded_link_url: Optional[StrictStr] = Field(default=None, description="Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.", alias="campaignEmbeddedLinkUrl")
+    campaign_embedded_phone: Optional[StrictBool] = Field(default=None, description="Whether campaign messages include phone numbers.", alias="campaignEmbeddedPhone")
+    campaign_age_gated: Optional[StrictBool] = Field(default=None, description="Whether campaign content is age-restricted (18+).", alias="campaignAgeGated")
+    campaign_direct_lending: Optional[StrictBool] = Field(default=None, description="Whether the campaign relates to direct lending or loan products.", alias="campaignDirectLending")
+    campaign_privacy_policy_link: Optional[StrictStr] = Field(default=None, description="Public URL of the privacy policy that covers this SMS program.", alias="campaignPrivacyPolicyLink")
+    campaign_terms_and_conditions_link: Optional[StrictStr] = Field(default=None, description="Public URL of the terms and conditions that cover this SMS program.", alias="campaignTermsAndConditionsLink")
+    campaign_usecase: Optional[StrictStr] = Field(default=None, description="10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.", alias="campaignUsecase")
     created_at: StrictStr = Field(alias="createdAt")
     updated_at: StrictStr = Field(alias="updatedAt")
     campaign_id: Optional[StrictStr] = Field(default=None, alias="campaignId")

{pingram_python-1.0.28 → pingram_python-1.0.29}/generated/pingram/models/ten_dlc_campaign_update_request.py

@@ -26,26 +26,26 @@ class TenDlcCampaignUpdateRequest(BaseModel):
     """
     Request body for PATCH /registrations/us/10dlc/campaign
     """ # noqa: E501
-    campaign_description: Optional[StrictStr] = Field(default=None, alias="campaignDescription")
-    campaign_sample1: Optional[StrictStr] = Field(default=None, alias="campaignSample1")
-    campaign_sample2: Optional[StrictStr] = Field(default=None, alias="campaignSample2")
-    campaign_sample3: Optional[StrictStr] = Field(default=None, alias="campaignSample3")
-    campaign_sample4: Optional[StrictStr] = Field(default=None, alias="campaignSample4")
-    campaign_message_flow: Optional[StrictStr] = Field(default=None, alias="campaignMessageFlow")
-    campaign_optin_keywords: Optional[StrictStr] = Field(default=None, alias="campaignOptinKeywords")
-    campaign_optin_message: Optional[StrictStr] = Field(default=None, alias="campaignOptinMessage")
-    campaign_optout_keywords: Optional[StrictStr] = Field(default=None, alias="campaignOptoutKeywords")
-    campaign_optout_message: Optional[StrictStr] = Field(default=None, alias="campaignOptoutMessage")
-    campaign_help_keywords: Optional[StrictStr] = Field(default=None, alias="campaignHelpKeywords")
-    campaign_help_message: Optional[StrictStr] = Field(default=None, alias="campaignHelpMessage")
-    campaign_embedded_link: Optional[StrictBool] = Field(default=None, alias="campaignEmbeddedLink")
-    campaign_embedded_link_url: Optional[StrictStr] = Field(default=None, alias="campaignEmbeddedLinkUrl")
-    campaign_embedded_phone: Optional[StrictBool] = Field(default=None, alias="campaignEmbeddedPhone")
-    campaign_age_gated: Optional[StrictBool] = Field(default=None, alias="campaignAgeGated")
-    campaign_direct_lending: Optional[StrictBool] = Field(default=None, alias="campaignDirectLending")
-    campaign_privacy_policy_link: Optional[StrictStr] = Field(default=None, alias="campaignPrivacyPolicyLink")
-    campaign_terms_and_conditions_link: Optional[StrictStr] = Field(default=None, alias="campaignTermsAndConditionsLink")
-    campaign_usecase: Optional[StrictStr] = Field(default=None, alias="campaignUsecase")
+    campaign_description: Optional[StrictStr] = Field(default=None, description="Summary of what this campaign sends and why, including audience and typical message content. Required before carrier submission.", alias="campaignDescription")
+    campaign_sample1: Optional[StrictStr] = Field(default=None, description="Example SMS that represents actual campaign traffic. Required before carrier submission. Should match the use case and typically identify the brand and include STOP/HELP language.", alias="campaignSample1")
+    campaign_sample2: Optional[StrictStr] = Field(default=None, description="Second example SMS. Required before carrier submission. Required for MARKETING and MIXED use cases.", alias="campaignSample2")
+    campaign_sample3: Optional[StrictStr] = Field(default=None, description="Optional third example SMS.", alias="campaignSample3")
+    campaign_sample4: Optional[StrictStr] = Field(default=None, description="Optional fourth example SMS.", alias="campaignSample4")
+    campaign_message_flow: Optional[StrictStr] = Field(default=None, description="How recipients opt in (for example website form, checkout, or keyword). Describe the call-to-action and where consent is collected. Required before carrier submission.", alias="campaignMessageFlow")
+    campaign_optin_keywords: Optional[StrictStr] = Field(default=None, description="Extra opt-in keywords as a comma-separated list. START is always included.", alias="campaignOptinKeywords")
+    campaign_optin_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient opts in. Required before carrier submission. Should confirm the subscription, mention message frequency, and include STOP and HELP instructions.", alias="campaignOptinMessage")
+    campaign_optout_keywords: Optional[StrictStr] = Field(default=None, description="Extra opt-out keywords as a comma-separated list. STOP is always included.", alias="campaignOptoutKeywords")
+    campaign_optout_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient opts out. Required before carrier submission. Should confirm they will receive no further messages.", alias="campaignOptoutMessage")
+    campaign_help_keywords: Optional[StrictStr] = Field(default=None, description="Extra help keywords as a comma-separated list. HELP is always included.", alias="campaignHelpKeywords")
+    campaign_help_message: Optional[StrictStr] = Field(default=None, description="Auto-reply sent when a recipient texts a help keyword. Required before carrier submission. Should include a support contact (email and/or phone).", alias="campaignHelpMessage")
+    campaign_embedded_link: Optional[StrictBool] = Field(default=None, description="Whether campaign messages include URLs.", alias="campaignEmbeddedLink")
+    campaign_embedded_link_url: Optional[StrictStr] = Field(default=None, description="Sample URL that appears in messages. Provide when campaignEmbeddedLink is true.", alias="campaignEmbeddedLinkUrl")
+    campaign_embedded_phone: Optional[StrictBool] = Field(default=None, description="Whether campaign messages include phone numbers.", alias="campaignEmbeddedPhone")
+    campaign_age_gated: Optional[StrictBool] = Field(default=None, description="Whether campaign content is age-restricted (18+).", alias="campaignAgeGated")
+    campaign_direct_lending: Optional[StrictBool] = Field(default=None, description="Whether the campaign relates to direct lending or loan products.", alias="campaignDirectLending")
+    campaign_privacy_policy_link: Optional[StrictStr] = Field(default=None, description="Public URL of the privacy policy that covers this SMS program.", alias="campaignPrivacyPolicyLink")
+    campaign_terms_and_conditions_link: Optional[StrictStr] = Field(default=None, description="Public URL of the terms and conditions that cover this SMS program.", alias="campaignTermsAndConditionsLink")
+    campaign_usecase: Optional[StrictStr] = Field(default=None, description="10DLC campaign use case submitted to carriers. Required before carrier submission. One of 2FA, ACCOUNT_NOTIFICATION, CUSTOMER_CARE, DELIVERY_NOTIFICATION, FRAUD_ALERT, MARKETING, MIXED, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, or SECURITY_ALERT. For MIXED, append comma-separated sub-use cases after MIXED (sub-use cases cannot include MIXED), for example MIXED,2FA,ACCOUNT_NOTIFICATION.", alias="campaignUsecase")
     __properties: ClassVar[List[str]] = ["campaignDescription", "campaignSample1", "campaignSample2", "campaignSample3", "campaignSample4", "campaignMessageFlow", "campaignOptinKeywords", "campaignOptinMessage", "campaignOptoutKeywords", "campaignOptoutMessage", "campaignHelpKeywords", "campaignHelpMessage", "campaignEmbeddedLink", "campaignEmbeddedLinkUrl", "campaignEmbeddedPhone", "campaignAgeGated", "campaignDirectLending", "campaignPrivacyPolicyLink", "campaignTermsAndConditionsLink", "campaignUsecase"]
 
     model_config = ConfigDict(