visier-platform-sdk 22222222.99200.21550__py3-none-any.whl → 22222222.99200.22171__py3-none-any.whl

visier_platform_sdk/models/tenant_management_api_list_response_dto.py

@@ -5,7 +5,7 @@
 
     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.21550
+    The version of the OpenAPI document: 22222222.99200.22171
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -29,8 +29,8 @@ 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.")
+    limit: Optional[StrictInt] = Field(default=None, description="The limit of analytic tenants to return.")
+    start: Optional[StrictInt] = Field(default=None, description="The starting index to retrieve values from, also known as offset.")
     __properties: ClassVar[List[str]] = ["tenants", "limit", "start"]
 
     model_config = ConfigDict(

visier_platform_sdk/models/tenant_management_api_update_request_dto.py

@@ -5,7 +5,7 @@
 
     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.21550
+    The version of the OpenAPI document: 22222222.99200.22171
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -33,9 +33,9 @@ class TenantManagementAPIUpdateRequestDTO(BaseModel):
     """ # 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")
+    tenant_short_name: Optional[StrictStr] = Field(default=None, description="This will no longer be available as of Spring 2028. A new short name to assign to the tenant.", 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")
+    industry_code: Optional[StrictInt] = Field(default=None, description="The North American Industry Classification System (NAICS) code for the industry in which the business operates.  Provide a value of 0 to use the business unit industry codes in the data or if the industry code is unknown. We highly recommend that you provide an industry code here or with the business units in the data to take advantage of all of Visier’s features.   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")
@@ -48,8 +48,9 @@ class TenantManagementAPIUpdateRequestDTO(BaseModel):
     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"]
+    traits: Optional[TenantDetailsTraitsDTO] = Field(default=None, description="The tenant's traits, including aggregation rights, tenant type, and data profile type. To set an analytic tenant's traits, contact Visier Technical Support.")
+    force_logins_with_session_based_permissions: Optional[StrictBool] = Field(default=None, description="If `true`, user sign in must also provide a `SessionRepoId`. Only valid if `SessionBasedPermissions` feature is enabled. Default is `false`.", alias="forceLoginsWithSessionBasedPermissions")
+    __properties: ClassVar[List[str]] = ["tenantCode", "tenantDisplayName", "tenantShortName", "vanityUrlName", "industryCode", "primaryBusinessLocation", "purchasedModules", "embeddableDomains", "customProperties", "ssoInstanceIssuers", "homeAnalysisId", "homeAnalysisByUserGroup", "updateAction", "enabled", "clickThroughLink", "defaultCurrency", "allowedOAuthIdpUrlDomains", "traits", "forceLoginsWithSessionBasedPermissions"]
 
     @field_validator('update_action')
     def update_action_validate_enum(cls, value):
@@ -149,7 +150,8 @@ class TenantManagementAPIUpdateRequestDTO(BaseModel):
             "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
+            "traits": TenantDetailsTraitsDTO.from_dict(obj["traits"]) if obj.get("traits") is not None else None,
+            "forceLoginsWithSessionBasedPermissions": obj.get("forceLoginsWithSessionBasedPermissions")
         })
         return _obj
 

visier_platform_sdk/models/tenant_management_api_update_response_dto.py

@@ -5,7 +5,7 @@
 
     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.21550
+    The version of the OpenAPI document: 22222222.99200.22171
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+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
@@ -45,7 +45,8 @@ class TenantManagementAPIUpdateResponseDTO(BaseModel):
     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"]
+    force_logins_with_session_based_permissions: Optional[StrictBool] = Field(default=None, description="If `true`, user sign in must also provide a `SessionRepoId`. Only set if `SessionBasedPermissions` feature is enabled. Default is `false`.", alias="forceLoginsWithSessionBasedPermissions")
+    __properties: ClassVar[List[str]] = ["tenantCode", "tenantDisplayName", "industryCode", "primaryBusinessLocation", "purchasedModules", "embeddableDomains", "customProperties", "ssoInstanceIssuers", "homeAnalysisId", "homeAnalysisByUserGroup", "status", "clickThroughLink", "vanityUrlName", "defaultCurrency", "allowedOAuthIdpUrlDomains", "forceLoginsWithSessionBasedPermissions"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -129,7 +130,8 @@ class TenantManagementAPIUpdateResponseDTO(BaseModel):
             "clickThroughLink": obj.get("clickThroughLink"),
             "vanityUrlName": obj.get("vanityUrlName"),
             "defaultCurrency": obj.get("defaultCurrency"),
-            "allowedOAuthIdpUrlDomains": obj.get("allowedOAuthIdpUrlDomains")
+            "allowedOAuthIdpUrlDomains": obj.get("allowedOAuthIdpUrlDomains"),
+            "forceLoginsWithSessionBasedPermissions": obj.get("forceLoginsWithSessionBasedPermissions")
         })
         return _obj
 

visier_platform_sdk/models/tenant_module_dto.py

@@ -5,7 +5,7 @@
 
     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.21550
+    The version of the OpenAPI document: 22222222.99200.22171
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/tenant_preview_entries_summary_dto.py

@@ -5,7 +5,7 @@
 
     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.21550
+    The version of the OpenAPI document: 22222222.99200.22171
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/tenant_preview_entries_summary_list_dto.py

@@ -5,7 +5,7 @@
 
     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.21550
+    The version of the OpenAPI document: 22222222.99200.22171
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/tenant_provision_apidto.py

@@ -5,7 +5,7 @@
 
     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.21550
+    The version of the OpenAPI document: 22222222.99200.22171
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -28,10 +28,10 @@ class TenantProvisionAPIDTO(BaseModel):
     """
     TenantProvisionAPIDTO
     """ # noqa: E501
-    tenant_code: Optional[StrictStr] = Field(default=None, description="The unique identifier of the analytic tenant.", alias="tenantCode")
-    tenant_display_name: Optional[StrictStr] = Field(default=None, description="The display name that is assigned to the analytic tenant.", alias="tenantDisplayName")
+    tenant_code: StrictStr = Field(description="The unique identifier of the analytic tenant.", alias="tenantCode")
+    tenant_display_name: StrictStr = Field(description="The display name that is assigned to the analytic tenant.", alias="tenantDisplayName")
     purchased_modules: Optional[List[StrictStr]] = Field(default=None, description="A comma-separated list of strings that represent the Visier 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. If the code is unknown, type 0.   For 2-digit codes, add trailing zeros at the end to reach 6 digits, such as 620000.", alias="industryCode")
+    industry_code: Optional[StrictInt] = Field(default=None, description="The North American Industry Classification System (NAICS) code for the industry in which the business operates.  Provide a value of 0 to use the business unit industry codes in the data or if the industry code is unknown. We highly recommend that you provide an industry code here or with the business units in the data to take advantage of all of Visier’s features.", alias="industryCode")
     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[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")

visier_platform_sdk/models/tenant_source_files_list_response_dto.py

@@ -0,0 +1,98 @@
+# 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.22171
+    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.source_file_response_dto import SourceFileResponseDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TenantSourceFilesListResponseDTO(BaseModel):
+    """
+    A list of the source's uploaded files.
+    """ # noqa: E501
+    tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant code of the analytic tenant that owns the source files.", alias="tenantCode")
+    source_files: Optional[List[SourceFileResponseDTO]] = Field(default=None, description="The files uploaded to a source.", alias="sourceFiles")
+    __properties: ClassVar[List[str]] = ["tenantCode", "sourceFiles"]
+
+    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 TenantSourceFilesListResponseDTO 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 source_files (list)
+        _items = []
+        if self.source_files:
+            for _item_source_files in self.source_files:
+                if _item_source_files:
+                    _items.append(_item_source_files.to_dict())
+            _dict['sourceFiles'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TenantSourceFilesListResponseDTO 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"),
+            "sourceFiles": [SourceFileResponseDTO.from_dict(_item) for _item in obj["sourceFiles"]] if obj.get("sourceFiles") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/tenant_status_apidto.py

@@ -5,7 +5,7 @@
 
     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.21550
+    The version of the OpenAPI document: 22222222.99200.22171
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/time_handling_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.99200.22171
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.periods_back_dto import PeriodsBackDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TimeHandlingDTO(BaseModel):
+    """
+    The time handling settings for a metric, which can be either per period or trailing periods.
+    """ # noqa: E501
+    per_period: Optional[StrictBool] = Field(default=None, description="The metric is evaluated per period, such as per month or per quarter.", alias="perPeriod")
+    trailing_periods: Optional[PeriodsBackDTO] = Field(default=None, description="The metric is evaluated over a trailing period, such as the last 12 months.", alias="trailingPeriods")
+    __properties: ClassVar[List[str]] = ["perPeriod", "trailingPeriods"]
+
+    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 TimeHandlingDTO 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 trailing_periods
+        if self.trailing_periods:
+            _dict['trailingPeriods'] = self.trailing_periods.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TimeHandlingDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "perPeriod": obj.get("perPeriod"),
+            "trailingPeriods": PeriodsBackDTO.from_dict(obj["trailingPeriods"]) if obj.get("trailingPeriods") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/time_period_dto.py

@@ -0,0 +1,120 @@
+# 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.22171
+    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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.relative_time_expression_dto import RelativeTimeExpressionDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TimePeriodDTO(BaseModel):
+    """
+    A time period can define a specific interval of time or relative time period.
+    """ # noqa: E501
+    end: Optional[StrictStr] = Field(default=None, description="The end of the time period.")
+    period_type: Optional[StrictStr] = Field(default=None, description="The period type for this interval. Default is `MONTH`.", alias="periodType")
+    period_count: Optional[StrictInt] = Field(default=None, description="The number of periods per interval. Default is 1.", alias="periodCount")
+    time_type: Optional[StrictStr] = Field(default=None, description="The type of time period.", alias="timeType")
+    expression: Optional[RelativeTimeExpressionDTO] = Field(default=None, description="The expression that defines the relative time period.")
+    __properties: ClassVar[List[str]] = ["end", "periodType", "periodCount", "timeType", "expression"]
+
+    @field_validator('period_type')
+    def period_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['MONTH', 'DAY', 'WEEK', 'QUARTER', 'YEAR']):
+            raise ValueError("must be one of enum values ('MONTH', 'DAY', 'WEEK', 'QUARTER', 'YEAR')")
+        return value
+
+    @field_validator('time_type')
+    def time_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['FIXED', 'PREVIOUS_PERIOD', 'PREVIOUS_YEAR', 'LAST_PERIOD_PREVIOUS_YEAR', 'CUSTOM', 'DYNAMIC_TIME', 'LAST_PERIODS']):
+            raise ValueError("must be one of enum values ('FIXED', 'PREVIOUS_PERIOD', 'PREVIOUS_YEAR', 'LAST_PERIOD_PREVIOUS_YEAR', 'CUSTOM', 'DYNAMIC_TIME', 'LAST_PERIODS')")
+        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 TimePeriodDTO 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 expression
+        if self.expression:
+            _dict['expression'] = self.expression.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TimePeriodDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "end": obj.get("end"),
+            "periodType": obj.get("periodType"),
+            "periodCount": obj.get("periodCount"),
+            "timeType": obj.get("timeType"),
+            "expression": RelativeTimeExpressionDTO.from_dict(obj["expression"]) if obj.get("expression") is not None else None
+        })
+        return _obj
+
+

visier_platform_sdk/models/time_period_filter_dto.py

@@ -0,0 +1,98 @@
+# 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.22171
+    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
+from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.dimension_reference_dto import DimensionReferenceDTO
+from visier_platform_sdk.models.time_period_dto import TimePeriodDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TimePeriodFilterDTO(BaseModel):
+    """
+    A filter that uses a time period.
+    """ # noqa: E501
+    dimension: Optional[DimensionReferenceDTO] = Field(default=None, description="The dimension to filter by.")
+    time_period: Optional[TimePeriodDTO] = Field(default=None, description="The time period to filter by.", alias="timePeriod")
+    __properties: ClassVar[List[str]] = ["dimension", "timePeriod"]
+
+    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 TimePeriodFilterDTO 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 dimension
+        if self.dimension:
+            _dict['dimension'] = self.dimension.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of time_period
+        if self.time_period:
+            _dict['timePeriod'] = self.time_period.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TimePeriodFilterDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "dimension": DimensionReferenceDTO.from_dict(obj["dimension"]) if obj.get("dimension") is not None else None,
+            "timePeriod": TimePeriodDTO.from_dict(obj["timePeriod"]) if obj.get("timePeriod") is not None else None
+        })
+        return _obj
+
+