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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pingram-python
-Version: 1.0.28
+Version: 1.0.30
 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.30}/generated/pingram/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.0.28"
+__version__ = "1.0.30"
 
 # Define package exports
 __all__ = [
@@ -57,6 +57,7 @@ __all__ = [
     "AccountAddressesResponse",
     "AccountAddressesResponseAddressesInner",
     "AccountGetResponse",
+    "AccountPatchRequest",
     "AddressResponse",
     "ApiErrorBody",
     "ApiErrorResponse",
@@ -369,6 +370,7 @@ from pingram.models.accept_invite_response import AcceptInviteResponse as Accept
 from pingram.models.account_addresses_response import AccountAddressesResponse as AccountAddressesResponse
 from pingram.models.account_addresses_response_addresses_inner import AccountAddressesResponseAddressesInner as AccountAddressesResponseAddressesInner
 from pingram.models.account_get_response import AccountGetResponse as AccountGetResponse
+from pingram.models.account_patch_request import AccountPatchRequest as AccountPatchRequest
 from pingram.models.address_response import AddressResponse as AddressResponse
 from pingram.models.api_error_body import ApiErrorBody as ApiErrorBody
 from pingram.models.api_error_response import ApiErrorResponse as ApiErrorResponse

{pingram_python-1.0.28 → pingram_python-1.0.30}/generated/pingram/api/account_api.py

@@ -20,6 +20,7 @@ from pydantic import Field, StrictFloat, StrictInt, StrictStr
 from typing import Optional, Union
 from typing_extensions import Annotated
 from pingram.models.account_get_response import AccountGetResponse
+from pingram.models.account_patch_request import AccountPatchRequest
 from pingram.models.billing_post_request_body import BillingPostRequestBody
 from pingram.models.billing_post_response_body import BillingPostResponseBody
 from pingram.models.get_usage_history_response import GetUsageHistoryResponse
@@ -2861,3 +2862,292 @@ class AccountApi:
         )
 
 
+
+
+    @validate_call
+    async def account_update_account_settings(
+        self,
+        account_patch_request: AccountPatchRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> AccountGetResponse:
+        """Update account billing preferences. Only account owners can change these settings.
+
+
+        :param account_patch_request: (required)
+        :type account_patch_request: AccountPatchRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._account_update_account_settings_serialize(
+            account_patch_request=account_patch_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AccountGetResponse",
+            '400': "ApiErrorResponse",
+            '401': None,
+            '402': "ApiErrorResponse",
+            '500': None,
+            '502': "ApiErrorResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def account_update_account_settings_with_http_info(
+        self,
+        account_patch_request: AccountPatchRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[AccountGetResponse]:
+        """Update account billing preferences. Only account owners can change these settings.
+
+
+        :param account_patch_request: (required)
+        :type account_patch_request: AccountPatchRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._account_update_account_settings_serialize(
+            account_patch_request=account_patch_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AccountGetResponse",
+            '400': "ApiErrorResponse",
+            '401': None,
+            '402': "ApiErrorResponse",
+            '500': None,
+            '502': "ApiErrorResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    async def account_update_account_settings_without_preload_content(
+        self,
+        account_patch_request: AccountPatchRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Update account billing preferences. Only account owners can change these settings.
+
+
+        :param account_patch_request: (required)
+        :type account_patch_request: AccountPatchRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._account_update_account_settings_serialize(
+            account_patch_request=account_patch_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AccountGetResponse",
+            '400': "ApiErrorResponse",
+            '401': None,
+            '402': "ApiErrorResponse",
+            '500': None,
+            '502': "ApiErrorResponse",
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _account_update_account_settings_serialize(
+        self,
+        account_patch_request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if account_patch_request is not None:
+            _body_params = account_patch_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'endUserHashed', 
+            'endUser', 
+            'apiKey', 
+            'clientCredentials'
+        ]
+
+        return self.api_client.param_serialize(
+            method='PATCH',
+            resource_path='/account',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

{pingram_python-1.0.28 → pingram_python-1.0.30}/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.30'
         self.client_side_validation = configuration.client_side_validation
 
     async def __aenter__(self):

{pingram_python-1.0.28 → pingram_python-1.0.30}/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.30".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

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

@@ -18,6 +18,7 @@ from pingram.models.accept_invite_response import AcceptInviteResponse
 from pingram.models.account_addresses_response import AccountAddressesResponse
 from pingram.models.account_addresses_response_addresses_inner import AccountAddressesResponseAddressesInner
 from pingram.models.account_get_response import AccountGetResponse
+from pingram.models.account_patch_request import AccountPatchRequest
 from pingram.models.address_response import AddressResponse
 from pingram.models.api_error_body import ApiErrorBody
 from pingram.models.api_error_response import ApiErrorResponse

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

@@ -36,12 +36,15 @@ 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")
+    auto_upgrade: Optional[StrictBool] = Field(default=None, description="When true, paid accounts move up one budget tier at 90% of the monthly budget.", alias="autoUpgrade")
+    __properties: ClassVar[List[str]] = ["accountId", "accountType", "creator", "name", "messagesCap", "costCap", "smsCap", "callCap", "billingVersion", "anniversaryDate", "createdAt", "updatedAt", "status", "subscriptionStatus", "pendingDowngradeEffectiveDate", "pendingDowngradeCostCap", "pendingDowngradeAccountType", "autoUpgrade"]
 
     @field_validator('account_type')
     def account_type_validate_enum(cls, value):
@@ -80,6 +83,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 +159,14 @@ 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"),
+            "autoUpgrade": obj.get("autoUpgrade")
         })
         return _obj
 

pingram_python-1.0.30/generated/pingram/models/account_patch_request.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    Pingram
+
+    Internal API for notification delivery and management
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AccountPatchRequest(BaseModel):
+    """
+    PATCH /account request: billing preferences.
+    """ # noqa: E501
+    auto_upgrade: Optional[StrictBool] = Field(default=None, description="When true, automatically move up one budget tier at 90% of the monthly budget.", alias="autoUpgrade")
+    __properties: ClassVar[List[str]] = ["autoUpgrade"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AccountPatchRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AccountPatchRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "autoUpgrade": obj.get("autoUpgrade")
+        })
+        return _obj
+
+

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

@@ -36,14 +36,17 @@ 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")
+    auto_upgrade: Optional[StrictBool] = Field(default=None, description="When true, paid accounts move up one budget tier at 90% of the monthly budget.", alias="autoUpgrade")
     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", "autoUpgrade", "sessionId", "url"]
 
     @field_validator('account_type')
     def account_type_validate_enum(cls, value):
@@ -82,6 +85,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 +161,14 @@ 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"),
+            "autoUpgrade": obj.get("autoUpgrade"),
             "sessionId": obj.get("sessionId"),
             "url": obj.get("url")
         })

{pingram_python-1.0.28 → pingram_python-1.0.30}/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.30}/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"),