visier-platform-sdk 22222222.99201.1914__py3-none-any.whl → 22222222.99201.1914b6__py3-none-any.whl

visier_platform_sdk/models/tenant_detail_apidto.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.1914
+    Contact: alpine@visier.com
+    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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.custom_tenant_property_dto import CustomTenantPropertyDTO
+from visier_platform_sdk.models.tenant_module_dto import TenantModuleDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TenantDetailAPIDTO(BaseModel):
+    """
+    TenantDetailAPIDTO
+    """ # noqa: E501
+    tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the analytic tenant. For example, \"WFF_j1r~i1o\".", alias="tenantCode")
+    tenant_display_name: Optional[StrictStr] = Field(default=None, description="An identifiable tenant name that is displayed within Visier. For example, \"Callisto\".", alias="tenantDisplayName")
+    status: Optional[StrictStr] = Field(default=None, description="Whether the tenant is enabled or disabled.")
+    provision_date: Optional[StrictStr] = Field(default=None, description="The date that the tenant was created.", alias="provisionDate")
+    current_data_version: Optional[StrictStr] = Field(default=None, description="The data version ID that the tenant is using.", alias="currentDataVersion")
+    data_version_date: Optional[StrictStr] = Field(default=None, description="The date that the data version was published to production.", alias="dataVersionDate")
+    modules: Optional[List[TenantModuleDTO]] = Field(default=None, description="The modules assigned to the analytic tenant.")
+    industry_code: Optional[StrictInt] = Field(default=None, description="The 6-digit NAICS code for the industry to which the analytic tenant belongs.", alias="industryCode")
+    can_administer_other_tenants: Optional[StrictBool] = Field(default=None, description="If true, the tenant is an administrating tenant.", alias="canAdministerOtherTenants")
+    embeddable_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded.", alias="embeddableDomains")
+    custom_properties: Optional[List[CustomTenantPropertyDTO]] = Field(default=None, description="A set of key-value pairs that represent different customizable properties for the analytic tenant.", alias="customProperties")
+    sso_instance_issuers: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant.", alias="ssoInstanceIssuers")
+    vanity_url_name: Optional[StrictStr] = Field(default=None, description="The name of the administrating tenant used in Visier URLs.", alias="vanityUrlName")
+    allowed_o_auth_idp_url_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, which can be used as values for the idp_url parameter", alias="allowedOAuthIdpUrlDomains")
+    __properties: ClassVar[List[str]] = ["tenantCode", "tenantDisplayName", "status", "provisionDate", "currentDataVersion", "dataVersionDate", "modules", "industryCode", "canAdministerOtherTenants", "embeddableDomains", "customProperties", "ssoInstanceIssuers", "vanityUrlName", "allowedOAuthIdpUrlDomains"]
+
+    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 TenantDetailAPIDTO 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in modules (list)
+        _items = []
+        if self.modules:
+            for _item_modules in self.modules:
+                if _item_modules:
+                    _items.append(_item_modules.to_dict())
+            _dict['modules'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in custom_properties (list)
+        _items = []
+        if self.custom_properties:
+            for _item_custom_properties in self.custom_properties:
+                if _item_custom_properties:
+                    _items.append(_item_custom_properties.to_dict())
+            _dict['customProperties'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TenantDetailAPIDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tenantCode": obj.get("tenantCode"),
+            "tenantDisplayName": obj.get("tenantDisplayName"),
+            "status": obj.get("status"),
+            "provisionDate": obj.get("provisionDate"),
+            "currentDataVersion": obj.get("currentDataVersion"),
+            "dataVersionDate": obj.get("dataVersionDate"),
+            "modules": [TenantModuleDTO.from_dict(_item) for _item in obj["modules"]] if obj.get("modules") is not None else None,
+            "industryCode": obj.get("industryCode"),
+            "canAdministerOtherTenants": obj.get("canAdministerOtherTenants"),
+            "embeddableDomains": obj.get("embeddableDomains"),
+            "customProperties": [CustomTenantPropertyDTO.from_dict(_item) for _item in obj["customProperties"]] if obj.get("customProperties") is not None else None,
+            "ssoInstanceIssuers": obj.get("ssoInstanceIssuers"),
+            "vanityUrlName": obj.get("vanityUrlName"),
+            "allowedOAuthIdpUrlDomains": obj.get("allowedOAuthIdpUrlDomains")
+        })
+        return _obj
+
+

visier_platform_sdk/models/tenant_details_traits_dto.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.1914
+    Contact: alpine@visier.com
+    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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TenantDetailsTraitsDTO(BaseModel):
+    """
+    The tenant's traits, including aggregation rights, tenant type, and data profile type.
+    """ # noqa: E501
+    aggregation_rights: Optional[StrictBool] = Field(default=None, description="If `true`, the tenant is opted in to Visier's data aggregation program, such as Visier Benchmarks. Default is `false`. If `false`, `aggregationRights` isn't returned in the response.", alias="aggregationRights")
+    tenant_type: Optional[StrictStr] = Field(default=None, description="The tenant's type. Valid values:  * `ENTERPRISE`: An analytic tenant managed by Visier that represents an enterprise customer's instance of Visier.  * `PARTNER`: An administrating tenant that manages one or more analytic tenants. Partner tenants are managed by non-Visier administrators, such as an embedded partner or system integration partner.  * `PARTNER_CUSTOMER`: An analytic tenant managed by a partner that represents the partner's customer's instance of Visier.", alias="tenantType")
+    data_profile_type: Optional[StrictStr] = Field(default=None, description="The tenant's data profile, which designates how the tenant's data is used. Valid values:  * `Regular`: An analytic tenant managed by Visier that represents an enterprise customer's instance of Visier.  * `Integration`: A partner tenant for development, staging, and testing.  * `Demo`: A Visier tenant for demonstrations and training.  * `Cat`: A consolidated analytics tenant for aggregating data from multiple analytic tenants in a single tenant.  * `Test`: A Visier tenant for development and testing.", alias="dataProfileType")
+    __properties: ClassVar[List[str]] = ["aggregationRights", "tenantType", "dataProfileType"]
+
+    @field_validator('tenant_type')
+    def tenant_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['ROOT_ADMIN', 'ROOT', 'BLUEPRINT', 'ENTERPRISE', 'ENTERPRISE_ROOT', 'BENCHMARK', 'PARTNER', 'PARTNER_CUSTOMER', 'SMB_BP', 'SMB_CUSTOMER', 'UNKNOWN']):
+            raise ValueError("must be one of enum values ('ROOT_ADMIN', 'ROOT', 'BLUEPRINT', 'ENTERPRISE', 'ENTERPRISE_ROOT', 'BENCHMARK', 'PARTNER', 'PARTNER_CUSTOMER', 'SMB_BP', 'SMB_CUSTOMER', 'UNKNOWN')")
+        return value
+
+    @field_validator('data_profile_type')
+    def data_profile_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Regular', 'Integration', 'Demo', 'Cat', 'Test']):
+            raise ValueError("must be one of enum values ('Regular', 'Integration', 'Demo', 'Cat', 'Test')")
+        return value
+
+    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 TenantDetailsTraitsDTO 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 TenantDetailsTraitsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "aggregationRights": obj.get("aggregationRights"),
+            "tenantType": obj.get("tenantType"),
+            "dataProfileType": obj.get("dataProfileType")
+        })
+        return _obj
+
+

visier_platform_sdk/models/tenant_encryption_key_details_dto.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.1914
+    Contact: alpine@visier.com
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TenantEncryptionKeyDetailsDTO(BaseModel):
+    """
+    Information about who generated an encryption key, its key name, algorithm, generation date, and expiration date.
+    """ # noqa: E501
+    key_name: Optional[StrictStr] = Field(default=None, description="The encryption key's display name. The name may only contain alphanumeric or dash (-) characters and must be between 6 and 36 characters long.", alias="keyName")
+    algorithm: Optional[StrictStr] = Field(default=None, description="The hash-based message authentication code and cryptographic hash function associated with the encryption key.")
+    generated_by: Optional[StrictStr] = Field(default=None, description="The user who generated the key.", alias="generatedBy")
+    date_generated: Optional[StrictStr] = Field(default=None, description="The UTC date that the key was generated in milliseconds since the Unix epoch.", alias="dateGenerated")
+    expiry_date: Optional[StrictStr] = Field(default=None, description="The UTC expiration date of the key in milliseconds since the Unix epoch.", alias="expiryDate")
+    __properties: ClassVar[List[str]] = ["keyName", "algorithm", "generatedBy", "dateGenerated", "expiryDate"]
+
+    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 TenantEncryptionKeyDetailsDTO 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 TenantEncryptionKeyDetailsDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "keyName": obj.get("keyName"),
+            "algorithm": obj.get("algorithm"),
+            "generatedBy": obj.get("generatedBy"),
+            "dateGenerated": obj.get("dateGenerated"),
+            "expiryDate": obj.get("expiryDate")
+        })
+        return _obj
+
+

visier_platform_sdk/models/tenant_encryption_key_dto.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.1914
+    Contact: alpine@visier.com
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.tenant_encryption_key_details_dto import TenantEncryptionKeyDetailsDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TenantEncryptionKeyDTO(BaseModel):
+    """
+    The details of an encryption key.
+    """ # noqa: E501
+    detail: Optional[TenantEncryptionKeyDetailsDTO] = Field(default=None, description="Information about an encryption key.")
+    key: Optional[StrictStr] = Field(default=None, description="The encryption key value.")
+    __properties: ClassVar[List[str]] = ["detail", "key"]
+
+    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 TenantEncryptionKeyDTO 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of detail
+        if self.detail:
+            _dict['detail'] = self.detail.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TenantEncryptionKeyDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "detail": TenantEncryptionKeyDetailsDTO.from_dict(obj["detail"]) if obj.get("detail") is not None else None,
+            "key": obj.get("key")
+        })
+        return _obj
+
+

visier_platform_sdk/models/tenant_management_api_get_response_dto.py

@@ -0,0 +1,156 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.1914
+    Contact: alpine@visier.com
+    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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.business_location_dto import BusinessLocationDTO
+from visier_platform_sdk.models.custom_property_dto import CustomPropertyDTO
+from visier_platform_sdk.models.home_analysis_by_user_group_dto import HomeAnalysisByUserGroupDTO
+from visier_platform_sdk.models.tenant_details_traits_dto import TenantDetailsTraitsDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TenantManagementAPIGetResponseDTO(BaseModel):
+    """
+    TenantManagementAPIGetResponseDTO
+    """ # noqa: E501
+    tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the analytic tenant. For example, \"WFF_j1r~i1o\"", alias="tenantCode")
+    tenant_display_name: Optional[StrictStr] = Field(default=None, description="An identifiable tenant name that is displayed within Visier. For example, \"Callisto\".", alias="tenantDisplayName")
+    status: Optional[StrictStr] = Field(default=None, description="Whether the tenant is enabled or disabled.")
+    provision_date: Optional[StrictStr] = Field(default=None, description="The date that the tenant was created.", alias="provisionDate")
+    current_data_version: Optional[StrictStr] = Field(default=None, description="The data version ID that the tenant is using.", alias="currentDataVersion")
+    data_version_date: Optional[StrictStr] = Field(default=None, description="The date that the data version was published to production.", alias="dataVersionDate")
+    purchased_modules: Optional[List[StrictStr]] = Field(default=None, description="The modules assigned to the analytic tenant.", alias="purchasedModules")
+    industry_code: Optional[StrictInt] = Field(default=None, description="The 6-digit NAICS code for the industry to which the analytic tenant belongs.", alias="industryCode")
+    primary_business_location: Optional[BusinessLocationDTO] = Field(default=None, description="The primary location of operations or where business is performed. If undefined, it is omitted from the response.", alias="primaryBusinessLocation")
+    can_administer_other_tenants: Optional[StrictBool] = Field(default=None, description="If true, the tenant is an administrating tenant.", alias="canAdministerOtherTenants")
+    embeddable_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, in which Visier can be embedded.", alias="embeddableDomains")
+    custom_properties: Optional[List[CustomPropertyDTO]] = Field(default=None, description="A set of key-value pairs that represent different customizable properties for the analytic tenant.", alias="customProperties")
+    sso_instance_issuers: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the issuers for the SSO providers that can authenticate this tenant.", alias="ssoInstanceIssuers")
+    vanity_url_name: Optional[StrictStr] = Field(default=None, description="The name of the administrating tenant used in Visier URLs.", alias="vanityUrlName")
+    home_analysis_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analysis that's displayed for this tenant when a user logs in.", alias="homeAnalysisId")
+    home_analysis_by_user_group: Optional[List[HomeAnalysisByUserGroupDTO]] = Field(default=None, description="A list of objects representing the analysis displayed to specific user groups when users log in.", alias="homeAnalysisByUserGroup")
+    click_through_link: Optional[StrictStr] = Field(default=None, description="The custom URL to redirect users into your portal to see the relevant content. This URL is used for links that are shared by and with your users through the sharing capability or email content.", alias="clickThroughLink")
+    click_through_link_enabled: Optional[StrictStr] = Field(default=None, description="Whether the click-through link is enabled or disabled.", alias="clickThroughLinkEnabled")
+    default_currency: Optional[StrictStr] = Field(default=None, description="The default currency to show in the application for the tenant.", alias="defaultCurrency")
+    allowed_o_auth_idp_url_domains: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the URLs, or domains, that are allowed in the idp_url OAuth parameter.", alias="allowedOAuthIdpUrlDomains")
+    effective_industry_code: Optional[StrictInt] = Field(default=None, description="The 6-digit NAICS code for the industry to which the analytic tenant belongs. This is calculated from industry codes in the tenant's data if the tenant has business unit data. Not returned if the effective industry code cannot be calculated.", alias="effectiveIndustryCode")
+    company_size: Optional[StrictInt] = Field(default=None, description="The latest headcount value for the analytic tenant. Not returned if no headcount data is available.", alias="companySize")
+    traits: Optional[TenantDetailsTraitsDTO] = Field(default=None, description="The tenant's traits, including aggregation rights, tenant type, and data profile type.")
+    __properties: ClassVar[List[str]] = ["tenantCode", "tenantDisplayName", "status", "provisionDate", "currentDataVersion", "dataVersionDate", "purchasedModules", "industryCode", "primaryBusinessLocation", "canAdministerOtherTenants", "embeddableDomains", "customProperties", "ssoInstanceIssuers", "vanityUrlName", "homeAnalysisId", "homeAnalysisByUserGroup", "clickThroughLink", "clickThroughLinkEnabled", "defaultCurrency", "allowedOAuthIdpUrlDomains", "effectiveIndustryCode", "companySize", "traits"]
+
+    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 TenantManagementAPIGetResponseDTO 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of primary_business_location
+        if self.primary_business_location:
+            _dict['primaryBusinessLocation'] = self.primary_business_location.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in custom_properties (list)
+        _items = []
+        if self.custom_properties:
+            for _item_custom_properties in self.custom_properties:
+                if _item_custom_properties:
+                    _items.append(_item_custom_properties.to_dict())
+            _dict['customProperties'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in home_analysis_by_user_group (list)
+        _items = []
+        if self.home_analysis_by_user_group:
+            for _item_home_analysis_by_user_group in self.home_analysis_by_user_group:
+                if _item_home_analysis_by_user_group:
+                    _items.append(_item_home_analysis_by_user_group.to_dict())
+            _dict['homeAnalysisByUserGroup'] = _items
+        # override the default output from pydantic by calling `to_dict()` of traits
+        if self.traits:
+            _dict['traits'] = self.traits.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TenantManagementAPIGetResponseDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tenantCode": obj.get("tenantCode"),
+            "tenantDisplayName": obj.get("tenantDisplayName"),
+            "status": obj.get("status"),
+            "provisionDate": obj.get("provisionDate"),
+            "currentDataVersion": obj.get("currentDataVersion"),
+            "dataVersionDate": obj.get("dataVersionDate"),
+            "purchasedModules": obj.get("purchasedModules"),
+            "industryCode": obj.get("industryCode"),
+            "primaryBusinessLocation": BusinessLocationDTO.from_dict(obj["primaryBusinessLocation"]) if obj.get("primaryBusinessLocation") is not None else None,
+            "canAdministerOtherTenants": obj.get("canAdministerOtherTenants"),
+            "embeddableDomains": obj.get("embeddableDomains"),
+            "customProperties": [CustomPropertyDTO.from_dict(_item) for _item in obj["customProperties"]] if obj.get("customProperties") is not None else None,
+            "ssoInstanceIssuers": obj.get("ssoInstanceIssuers"),
+            "vanityUrlName": obj.get("vanityUrlName"),
+            "homeAnalysisId": obj.get("homeAnalysisId"),
+            "homeAnalysisByUserGroup": [HomeAnalysisByUserGroupDTO.from_dict(_item) for _item in obj["homeAnalysisByUserGroup"]] if obj.get("homeAnalysisByUserGroup") is not None else None,
+            "clickThroughLink": obj.get("clickThroughLink"),
+            "clickThroughLinkEnabled": obj.get("clickThroughLinkEnabled"),
+            "defaultCurrency": obj.get("defaultCurrency"),
+            "allowedOAuthIdpUrlDomains": obj.get("allowedOAuthIdpUrlDomains"),
+            "effectiveIndustryCode": obj.get("effectiveIndustryCode"),
+            "companySize": obj.get("companySize"),
+            "traits": TenantDetailsTraitsDTO.from_dict(obj["traits"]) if obj.get("traits") is not None else None
+        })
+        return _obj
+
+