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

visier_platform_sdk/models/vee_question_category_change_failure_dto.py

@@ -0,0 +1,104 @@
+# 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.22144
+    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.category_icon_dto import CategoryIconDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VeeQuestionCategoryChangeFailureDTO(BaseModel):
+    """
+    The list of failed changes.
+    """ # noqa: E501
+    display_name: Optional[StrictStr] = Field(default=None, description="The name in plain language that was successfully changed.", alias="displayName")
+    category_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the question category that was successfully changed.", alias="categoryId")
+    category_icon: Optional[CategoryIconDTO] = Field(default=None, description="The question category icons that were successfully changed.", alias="categoryIcon")
+    message: Optional[StrictStr] = Field(default=None, description="An error message describing the cause of the failure.")
+    rci: Optional[StrictStr] = Field(default=None, description="The root cause identifier to provide to Visier Technical Support if you require further troubleshooting.")
+    tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant that the object was not successfully changed in.", alias="tenantCode")
+    project_id: Optional[StrictStr] = Field(default=None, description="The project that the object was not successfully changed in.", alias="projectId")
+    __properties: ClassVar[List[str]] = ["displayName", "categoryId", "categoryIcon", "message", "rci", "tenantCode", "projectId"]
+
+    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 VeeQuestionCategoryChangeFailureDTO 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 category_icon
+        if self.category_icon:
+            _dict['categoryIcon'] = self.category_icon.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VeeQuestionCategoryChangeFailureDTO 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"),
+            "categoryId": obj.get("categoryId"),
+            "categoryIcon": CategoryIconDTO.from_dict(obj["categoryIcon"]) if obj.get("categoryIcon") is not None else None,
+            "message": obj.get("message"),
+            "rci": obj.get("rci"),
+            "tenantCode": obj.get("tenantCode"),
+            "projectId": obj.get("projectId")
+        })
+        return _obj
+
+

visier_platform_sdk/models/vee_question_category_change_success_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.22144
+    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.category_icon_dto import CategoryIconDTO
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VeeQuestionCategoryChangeSuccessDTO(BaseModel):
+    """
+    The list of successful changes.
+    """ # noqa: E501
+    display_name: Optional[StrictStr] = Field(default=None, description="The name in plain language that was successfully changed.", alias="displayName")
+    category_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the question category that was successfully changed.", alias="categoryId")
+    category_icon: Optional[CategoryIconDTO] = Field(default=None, description="The question category icons that were successfully changed.", alias="categoryIcon")
+    tenant_code: Optional[StrictStr] = Field(default=None, description="The tenant that the question category was changed in.", alias="tenantCode")
+    project_id: Optional[StrictStr] = Field(default=None, description="The project that the question category was changed in.", alias="projectId")
+    __properties: ClassVar[List[str]] = ["displayName", "categoryId", "categoryIcon", "tenantCode", "projectId"]
+
+    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 VeeQuestionCategoryChangeSuccessDTO 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 category_icon
+        if self.category_icon:
+            _dict['categoryIcon'] = self.category_icon.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VeeQuestionCategoryChangeSuccessDTO 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"),
+            "categoryId": obj.get("categoryId"),
+            "categoryIcon": CategoryIconDTO.from_dict(obj["categoryIcon"]) if obj.get("categoryIcon") is not None else None,
+            "tenantCode": obj.get("tenantCode"),
+            "projectId": obj.get("projectId")
+        })
+        return _obj
+
+

visier_platform_sdk/models/vee_question_category_delete_definitions_by_tenant_dto.py

@@ -0,0 +1,92 @@
+# 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.22144
+    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 VeeQuestionCategoryDeleteDefinitionsByTenantDTO(BaseModel):
+    """
+    Information about the question category and the context of the API request, such as the tenant code and project ID.
+    """ # noqa: E501
+    tenant_code: Optional[StrictStr] = Field(default=None, description="The code of the tenant to delete question categories from. Default is the current tenant.", alias="tenantCode")
+    project_id: Optional[StrictStr] = Field(default=None, description="The project in which to delete question categories. If omitted and the `ProjectID` request header is not defined, the change is published to production immediately.", alias="projectId")
+    category_ids: Optional[List[StrictStr]] = Field(default=None, description="The IDs of the question categories to delete for a specific tenant.", alias="categoryIds")
+    __properties: ClassVar[List[str]] = ["tenantCode", "projectId", "categoryIds"]
+
+    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 VeeQuestionCategoryDeleteDefinitionsByTenantDTO 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 VeeQuestionCategoryDeleteDefinitionsByTenantDTO 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"),
+            "projectId": obj.get("projectId"),
+            "categoryIds": obj.get("categoryIds")
+        })
+        return _obj
+
+

visier_platform_sdk/models/vee_question_change_definition_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_question_change_definitions_by_tenant_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_question_change_failure_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_question_change_success_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_question_delete_definitions_by_tenant_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_question_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_questions_bulk_change_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_questions_change_definitions_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_questions_delete_definitions_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -23,6 +23,7 @@ from typing import Any, ClassVar, Dict, List, Optional
 from visier_platform_sdk.models.vee_conversation_state_dto import VeeConversationStateDTO
 from visier_platform_sdk.models.vee_corrections_dto import VeeCorrectionsDTO
 from visier_platform_sdk.models.vee_data_dto import VeeDataDTO
+from visier_platform_sdk.models.vee_detail_data_dto import VeeDetailDataDTO
 from visier_platform_sdk.models.vee_response_schema_dto import VeeResponseSchemaDTO
 from visier_platform_sdk.models.vee_status_code_dto import VeeStatusCodeDTO
 from visier_platform_sdk.models.vee_visual_dto import VeeVisualDTO
@@ -42,7 +43,8 @@ class VeeResponseDTO(BaseModel):
     data: Optional[VeeDataDTO] = Field(default=None, description="Returned if `includeData` is `true`. Provides additional data relevant to the question, such as the visualization data and any filters applied to the visualization.")
     visual: Optional[VeeVisualDTO] = Field(default=None, description="A base64 string-encoded PNG of a visualization generated by Vee to answer a question. For example, Vee can return a Breakdown visualization if asked about the headcount in each organization.")
     reworded_question: Optional[StrictStr] = Field(default=None, description="Vee's plain language interpretation of the original question. For example, if you asked \"what is the headcount by gender in each org?\", Vee might reword the question as \"What is the gender breakdown of our workforce by organization this month?\".", alias="rewordedQuestion")
-    __properties: ClassVar[List[str]] = ["conversationState", "statusCode", "narrative", "chartUrl", "schema", "corrections", "data", "visual", "rewordedQuestion"]
+    detail_data: Optional[List[VeeDetailDataDTO]] = Field(default=None, description="Returns if `includeDetailData` is `true`. Provides additional detail data relevant to the questions.", alias="detailData")
+    __properties: ClassVar[List[str]] = ["conversationState", "statusCode", "narrative", "chartUrl", "schema", "corrections", "data", "visual", "rewordedQuestion", "detailData"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -105,6 +107,13 @@ class VeeResponseDTO(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of visual
         if self.visual:
             _dict['visual'] = self.visual.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in detail_data (list)
+        _items = []
+        if self.detail_data:
+            for _item_detail_data in self.detail_data:
+                if _item_detail_data:
+                    _items.append(_item_detail_data.to_dict())
+            _dict['detailData'] = _items
         return _dict
 
     @classmethod
@@ -125,7 +134,8 @@ class VeeResponseDTO(BaseModel):
             "corrections": [VeeCorrectionsDTO.from_dict(_item) for _item in obj["corrections"]] if obj.get("corrections") is not None else None,
             "data": VeeDataDTO.from_dict(obj["data"]) if obj.get("data") is not None else None,
             "visual": VeeVisualDTO.from_dict(obj["visual"]) if obj.get("visual") is not None else None,
-            "rewordedQuestion": obj.get("rewordedQuestion")
+            "rewordedQuestion": obj.get("rewordedQuestion"),
+            "detailData": [VeeDetailDataDTO.from_dict(_item) for _item in obj["detailData"]] if obj.get("detailData") is not None else None
         })
         return _obj
 

visier_platform_sdk/models/vee_response_schema_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_response_schema_reference_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_sample_question_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_sample_question_library_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_status_code_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_status_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_visual_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/vee_visual_options_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/version_information_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/visible_for_selection_dto.py

@@ -0,0 +1,101 @@
+# 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.22144
+    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 VisibleForSelectionDTO(BaseModel):
+    """
+    VisibleForSelectionDTO
+    """ # noqa: E501
+    enabled: Optional[StrictBool] = Field(default=None, description="If `true`, the user group is visible in features such as sharing an analysis with user groups or assigning user groups a Vee sample question. Cannot update to `true` if `features` is empty.  If `false`, the user group is not visible to select in any features.  Default is `true`.  **Note**: User group visibility is not available until Summer 2025.")
+    features: Optional[List[StrictStr]] = Field(default=None, description="The features in which the user group is visible. Default is empty.  If `enabled` is `true`, the user group is visible in features listed.  If `enabled` is `false`, this field is ignored.  **Note**: User group visibility is not available until Summer 2025.")
+    __properties: ClassVar[List[str]] = ["enabled", "features"]
+
+    @field_validator('features')
+    def features_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['AnalyticsFeatures', 'StudioFeatures']):
+                raise ValueError("each list item must be one of ('AnalyticsFeatures', 'StudioFeatures')")
+        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 VisibleForSelectionDTO 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 VisibleForSelectionDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "enabled": obj.get("enabled"),
+            "features": obj.get("features")
+        })
+        return _obj
+
+

visier_platform_sdk/models/webhook_basic_auth_credential_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/webhook_credentials_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.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)