visier-platform-sdk 22222222.99200.21494__py3-none-any.whl

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.99200.21494
+    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
+
+

visier_platform_sdk/models/tenant_management_api_list_response_dto.py

@@ -0,0 +1,100 @@
+# 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.99200.21494
+    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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.tenant_management_api_get_response_dto import TenantManagementAPIGetResponseDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TenantManagementAPIListResponseDTO(BaseModel):
+    """
+    TenantManagementAPIListResponseDTO
+    """ # noqa: E501
+    tenants: Optional[List[TenantManagementAPIGetResponseDTO]] = Field(default=None, description="A list of objects representing all the analytic tenants.")
+    limit: Optional[StrictInt] = Field(default=None, description="The limit of analytic tenants to return. The maximum value is 1000. The default is 150.")
+    start: Optional[StrictInt] = Field(default=None, description="The index to start retrieving values from, also known as offset. The index begins at 0.")
+    __properties: ClassVar[List[str]] = ["tenants", "limit", "start"]
+
+    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 TenantManagementAPIListResponseDTO 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 tenants (list)
+        _items = []
+        if self.tenants:
+            for _item_tenants in self.tenants:
+                if _item_tenants:
+                    _items.append(_item_tenants.to_dict())
+            _dict['tenants'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TenantManagementAPIListResponseDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "tenants": [TenantManagementAPIGetResponseDTO.from_dict(_item) for _item in obj["tenants"]] if obj.get("tenants") is not None else None,
+            "limit": obj.get("limit"),
+            "start": obj.get("start")
+        })
+        return _obj
+
+

visier_platform_sdk/models/tenant_management_api_update_request_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.99200.21494
+    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, field_validator
+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 TenantManagementAPIUpdateRequestDTO(BaseModel):
+    """
+    TenantManagementAPIUpdateRequestDTO
+    """ # noqa: E501
+    tenant_code: Optional[StrictStr] = Field(default=None, description="A unique identifier for the newly created analytic tenant. Required if creating new tenants.", alias="tenantCode")
+    tenant_display_name: Optional[StrictStr] = Field(default=None, description="A new display name to assign to the analytic tenant. Required if creating new tenants.", alias="tenantDisplayName")
+    tenant_short_name: Optional[StrictStr] = Field(default=None, description="A new short name to assign to the tenant. Required for analytic tenants.", alias="tenantShortName")
+    vanity_url_name: Optional[StrictStr] = Field(default=None, description="A new vanity name to assign to the tenant. Omit for new Embedded analytic tenants.", alias="vanityUrlName")
+    industry_code: Optional[StrictInt] = Field(default=None, description="The 6-digit NAICS code for the industry to which the analytic tenant belongs. If the code is unknown, type 0.   For 2-digit codes, add trailing zeros at the end to reach 6 digits, such as 620000. Required if creating new tenants.", alias="industryCode")
+    primary_business_location: Optional[BusinessLocationDTO] = Field(default=None, description="The primary location of operations or where business is performed. This field is optional.", alias="primaryBusinessLocation")
+    purchased_modules: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant. Required if creating new tenants.   To get the module name:  1. In Visier, open a project and navigate to **Model > Modules**.  2. Select a module.  3. In **Basic Information**, copy the **Object name**. This is the module name.", alias="purchasedModules")
+    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. If domains at the administrating tenant level match the domains at the analytic tenant level, you do not need to include a domain for each analytic tenant. This is optional.", alias="embeddableDomains")
+    custom_properties: Optional[List[CustomPropertyDTO]] = Field(default=None, description="A list of objects that represent different customizable properties for the analytic tenant. This is optional.", 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. This is optional.", alias="ssoInstanceIssuers")
+    home_analysis_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analysis to display for this tenant when a user logs in. This is optional. Causes the API request to take longer because it must publish a project to production.   Retrieve the ID by opening an analysis in the production version of a tenant and copying the string after the last forward slash (/) in the URL. For example: `https://jupiter.visier.com/hr/prod/appcontainer?previewId=-eZPm8xvo3SUMpD4Q5pdE-6mCj9CQ9K699XgqRGwtOxagH5x2IzDFawlWn3hYqFEfU7nP0YK9ASEzmrNfAihGg..&previewType=Production#/analytics/myanalyses/8a4c1d4f-eb61-4da0-9e5b-55bef757c30e`.   The `homeAnalysisID` is `8a4c1d4f-eb61-4da0-9e5b-55bef757c30e`. Alternatively, retrieve the ID by copying the `Analysis ID` or `contentId` found by following the `Embed a Visualization` documentation.", alias="homeAnalysisId")
+    home_analysis_by_user_group: Optional[List[HomeAnalysisByUserGroupDTO]] = Field(default=None, description="A list of objects representing the analysis to display to specific user groups when users log in. This is optional. Causes the API request to take longer because it must publish a project to production.", alias="homeAnalysisByUserGroup")
+    update_action: Optional[StrictStr] = Field(default=None, description="Specifies the way you want to update values. Default is MERGE.  Valid values:  - `MERGE`: Combine the existing values with the new values.  - `REPLACE`: Remove existing values and let the new values take their place.", alias="updateAction")
+    enabled: Optional[StrictBool] = Field(default=None, description="If true, the tenant is enabled. Enabled tenants have access to Visier visualizations.")
+    click_through_link: Optional[StrictStr] = Field(default=None, description="A 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. This is optional. Causes the API request to take longer because it must publish a project to production.", alias="clickThroughLink")
+    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. This is optional.", alias="allowedOAuthIdpUrlDomains")
+    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", "tenantShortName", "vanityUrlName", "industryCode", "primaryBusinessLocation", "purchasedModules", "embeddableDomains", "customProperties", "ssoInstanceIssuers", "homeAnalysisId", "homeAnalysisByUserGroup", "updateAction", "enabled", "clickThroughLink", "defaultCurrency", "allowedOAuthIdpUrlDomains", "traits"]
+
+    @field_validator('update_action')
+    def update_action_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['MERGE', 'REPLACE']):
+            raise ValueError("must be one of enum values ('MERGE', 'REPLACE')")
+        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 TenantManagementAPIUpdateRequestDTO 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 TenantManagementAPIUpdateRequestDTO 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"),
+            "tenantShortName": obj.get("tenantShortName"),
+            "vanityUrlName": obj.get("vanityUrlName"),
+            "industryCode": obj.get("industryCode"),
+            "primaryBusinessLocation": BusinessLocationDTO.from_dict(obj["primaryBusinessLocation"]) if obj.get("primaryBusinessLocation") is not None else None,
+            "purchasedModules": obj.get("purchasedModules"),
+            "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"),
+            "homeAnalysisId": obj.get("homeAnalysisId"),
+            "homeAnalysisByUserGroup": [HomeAnalysisByUserGroupDTO.from_dict(_item) for _item in obj["homeAnalysisByUserGroup"]] if obj.get("homeAnalysisByUserGroup") is not None else None,
+            "updateAction": obj.get("updateAction"),
+            "enabled": obj.get("enabled"),
+            "clickThroughLink": obj.get("clickThroughLink"),
+            "defaultCurrency": obj.get("defaultCurrency"),
+            "allowedOAuthIdpUrlDomains": obj.get("allowedOAuthIdpUrlDomains"),
+            "traits": TenantDetailsTraitsDTO.from_dict(obj["traits"]) if obj.get("traits") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/tenant_management_api_update_response_dto.py

@@ -0,0 +1,136 @@
+# 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.99200.21494
+    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, 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 typing import Optional, Set
+from typing_extensions import Self
+
+class TenantManagementAPIUpdateResponseDTO(BaseModel):
+    """
+    TenantManagementAPIUpdateResponseDTO
+    """ # noqa: E501
+    tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier of the newly created analytic tenant.", alias="tenantCode")
+    tenant_display_name: Optional[StrictStr] = Field(default=None, description="A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant.", alias="tenantDisplayName")
+    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")
+    purchased_modules: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant.", alias="purchasedModules")
+    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. If domains at the administrating tenant level match the domains at the analytic tenant level, you do not need to include a domain for each analytic tenant.", alias="embeddableDomains")
+    custom_properties: Optional[List[CustomPropertyDTO]] = Field(default=None, description="A list of objects 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")
+    home_analysis_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the analysis to display for this tenant when a user logs in. This is optional.   Retrieve the ID by opening an analysis in the production version of a tenant and copying the string after the last forward slash (/) in the URL. For example: https://jupiter.visier.com/hr/prod/appcontainer?previewId=-eZPm8xvo3SUMpD4Q5pdE-6mCj9CQ9K699XgqRGwtOxagH5x2IzDFawlWn3hYqFEfU7nP0YK9ASEzmrNfAihGg..&previewType=Production#/analytics/myanalyses/`8a4c1d4f-eb61-4da0-9e5b-55bef757c30e`.  The `homeAnalysisID` is `8a4c1d4f-eb61-4da0-9e5b-55bef757c30e`.   Alternatively, retrieve the ID by copying the `Analysis ID` or `contentId` found by following the `Embed a Visualization` documentation.", alias="homeAnalysisId")
+    home_analysis_by_user_group: Optional[List[HomeAnalysisByUserGroupDTO]] = Field(default=None, description="A list of objects representing the analysis to display to specific user groups when users log in.", alias="homeAnalysisByUserGroup")
+    status: Optional[StrictStr] = Field(default=None, description="Whether the tenant is enabled or disabled. Enabled tenants have access to Visier visualizations.")
+    click_through_link: Optional[StrictStr] = Field(default=None, description="A 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")
+    vanity_url_name: Optional[StrictStr] = Field(default=None, description="The name of the administrating tenant used in Visier URLs.", alias="vanityUrlName")
+    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. This is optional.", alias="allowedOAuthIdpUrlDomains")
+    __properties: ClassVar[List[str]] = ["tenantCode", "tenantDisplayName", "industryCode", "primaryBusinessLocation", "purchasedModules", "embeddableDomains", "customProperties", "ssoInstanceIssuers", "homeAnalysisId", "homeAnalysisByUserGroup", "status", "clickThroughLink", "vanityUrlName", "defaultCurrency", "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 TenantManagementAPIUpdateResponseDTO 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
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TenantManagementAPIUpdateResponseDTO 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"),
+            "industryCode": obj.get("industryCode"),
+            "primaryBusinessLocation": BusinessLocationDTO.from_dict(obj["primaryBusinessLocation"]) if obj.get("primaryBusinessLocation") is not None else None,
+            "purchasedModules": obj.get("purchasedModules"),
+            "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"),
+            "homeAnalysisId": obj.get("homeAnalysisId"),
+            "homeAnalysisByUserGroup": [HomeAnalysisByUserGroupDTO.from_dict(_item) for _item in obj["homeAnalysisByUserGroup"]] if obj.get("homeAnalysisByUserGroup") is not None else None,
+            "status": obj.get("status"),
+            "clickThroughLink": obj.get("clickThroughLink"),
+            "vanityUrlName": obj.get("vanityUrlName"),
+            "defaultCurrency": obj.get("defaultCurrency"),
+            "allowedOAuthIdpUrlDomains": obj.get("allowedOAuthIdpUrlDomains")
+        })
+        return _obj
+
+

visier_platform_sdk/models/tenant_module_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.99200.21494
+    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.module_settings_dto import ModuleSettingsDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TenantModuleDTO(BaseModel):
+    """
+    TenantModuleDTO
+    """ # noqa: E501
+    display_name: Optional[StrictStr] = Field(default=None, description="An identifiable name that is displayed within Visier. For example, \"TALENT\".", alias="displayName")
+    symbol_name: Optional[StrictStr] = Field(default=None, description="The symbol name of the module. For example, \"Talent_Management\".", alias="symbolName")
+    module_settings: Optional[ModuleSettingsDTO] = Field(default=None, description="The settings associated with the module.", alias="moduleSettings")
+    __properties: ClassVar[List[str]] = ["displayName", "symbolName", "moduleSettings"]
+
+    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 TenantModuleDTO 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 module_settings
+        if self.module_settings:
+            _dict['moduleSettings'] = self.module_settings.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TenantModuleDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "displayName": obj.get("displayName"),
+            "symbolName": obj.get("symbolName"),
+            "moduleSettings": ModuleSettingsDTO.from_dict(obj["moduleSettings"]) if obj.get("moduleSettings") is not None else None
+        })
+        return _obj
+
+