visier-platform-sdk 22222222.99201.2050__py3-none-any.whl → 22222222.99201.2165__py3-none-any.whl

visier_platform_sdk/models/permission_success_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/permissions_list_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/permissions_to_user_group_for_tenant_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/permissions_to_user_group_request_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/permissions_to_user_groups_request_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/persisted_cohort_filter_dto.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    API Reference
+
+    Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
+
+    The version of the OpenAPI document: 22222222.99201.2165
+    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 PersistedCohortFilterDTO(BaseModel):
+    """
+    A filter that uses a persisted cohort in Visier.
+    """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the concept reference.")
+    qualifying_path: Optional[StrictStr] = Field(default=None, description="The qualifying path to the persisted cohort in Visier, such as the analytic object or event the selection  concept is associated with. If the path has multiple objects, each object is separated by a period.", alias="qualifyingPath")
+    __properties: ClassVar[List[str]] = ["id", "qualifyingPath"]
+
+    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 PersistedCohortFilterDTO 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 PersistedCohortFilterDTO from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "qualifyingPath": obj.get("qualifyingPath")
+        })
+        return _obj
+
+

visier_platform_sdk/models/perspective_configuration_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/perspective_node_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/plan_data_load_change_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/plan_data_load_change_list_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/plan_data_load_error_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/plan_data_upload_response_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/plan_info_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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
@@ -20,6 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from visier_platform_sdk.models.collaboration_info import CollaborationInfo
 from visier_platform_sdk.models.scenario_info_dto import ScenarioInfoDTO
 from typing import Optional, Set
 from typing_extensions import Self
@@ -32,9 +32,10 @@ class PlanInfoDTO(BaseModel):
     display_name: Optional[StrictStr] = Field(default=None, description="The display name of the plan.", alias="displayName")
     model_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the planning model that the plan is using.", alias="modelId")
     scenarios: Optional[List[ScenarioInfoDTO]] = Field(default=None, description="Information about the plan's scenarios.")
+    collaborations: Optional[List[CollaborationInfo]] = Field(default=None, description="Information about the plan's collaborations.")
     parent_plan_uuid: Optional[StrictStr] = Field(default=None, description="If the plan is a subplan, the response returns its parent plan's UUID. Not returned for main plans.", alias="parentPlanUuid")
     currency_code: Optional[StrictStr] = Field(default=None, description="The 3-digit ISO 4217 currency code of the plan's data.", alias="currencyCode")
-    __properties: ClassVar[List[str]] = ["uuid", "displayName", "modelId", "scenarios", "parentPlanUuid", "currencyCode"]
+    __properties: ClassVar[List[str]] = ["uuid", "displayName", "modelId", "scenarios", "collaborations", "parentPlanUuid", "currencyCode"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -82,6 +83,13 @@ class PlanInfoDTO(BaseModel):
                 if _item_scenarios:
                     _items.append(_item_scenarios.to_dict())
             _dict['scenarios'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in collaborations (list)
+        _items = []
+        if self.collaborations:
+            for _item_collaborations in self.collaborations:
+                if _item_collaborations:
+                    _items.append(_item_collaborations.to_dict())
+            _dict['collaborations'] = _items
         return _dict
 
     @classmethod
@@ -98,6 +106,7 @@ class PlanInfoDTO(BaseModel):
             "displayName": obj.get("displayName"),
             "modelId": obj.get("modelId"),
             "scenarios": [ScenarioInfoDTO.from_dict(_item) for _item in obj["scenarios"]] if obj.get("scenarios") is not None else None,
+            "collaborations": [CollaborationInfo.from_dict(_item) for _item in obj["collaborations"]] if obj.get("collaborations") is not None else None,
             "parentPlanUuid": obj.get("parentPlanUuid"),
             "currencyCode": obj.get("currencyCode")
         })

visier_platform_sdk/models/plan_item_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/plan_parameter_definition_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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

visier_platform_sdk/models/plan_parameter_value_dto.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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
@@ -27,11 +26,12 @@ class PlanParameterValueDTO(BaseModel):
     """
     The value for a parameter on a planning metric, including the parameter ID and the plan the parameter is based on.
     """ # noqa: E501
-    parameter_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the plan parameter qualified by the object.", alias="parameterId")
-    plan_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the plan the parameter is based on.", alias="planId")
-    scenario_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the scenario the parameter is based on.", alias="scenarioId")
-    snapshot_id: Optional[StrictStr] = Field(default=None, description="The unique ID of the snapshot the parameter is based on.", alias="snapshotId")
-    __properties: ClassVar[List[str]] = ["parameterId", "planId", "scenarioId", "snapshotId"]
+    parameter_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the plan parameter qualified by the object.", alias="parameterId")
+    plan_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the plan the parameter is based on.", alias="planId")
+    scenario_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the scenario the parameter is based on.", alias="scenarioId")
+    snapshot_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the snapshot the parameter is based on.", alias="snapshotId")
+    exploration_snapshot_id: Optional[StrictStr] = Field(default=None, description="The unique identifier of the exploration snapshot the parameter is based on.", alias="explorationSnapshotId")
+    __properties: ClassVar[List[str]] = ["parameterId", "planId", "scenarioId", "snapshotId", "explorationSnapshotId"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -87,7 +87,8 @@ class PlanParameterValueDTO(BaseModel):
             "parameterId": obj.get("parameterId"),
             "planId": obj.get("planId"),
             "scenarioId": obj.get("scenarioId"),
-            "snapshotId": obj.get("snapshotId")
+            "snapshotId": obj.get("snapshotId"),
+            "explorationSnapshotId": obj.get("explorationSnapshotId")
         })
         return _obj
 

visier_platform_sdk/models/plan_patch_consolidate_action_request.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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
@@ -28,7 +27,7 @@ class PlanPatchConsolidateActionRequest(BaseModel):
     """
     PlanPatchConsolidateActionRequest
     """ # noqa: E501
-    action_type: StrictStr = Field(description="The action to perform on the subplan. Valid values: - `Consolidate`: Combine the submitted subplan values into the main plan. - `Reopen`: Reopen consolidated subplans so subplanners can change the values. ", alias="actionType")
+    action_type: StrictStr = Field(description="The action to perform on the main plan or the subplan, in a specific scenario. Valid values: - `Consolidate`: Combine the submitted subplan values into the main plan. - `Submit`: Send your completed subplan to the plan coordinator for review. - `Reopen`: Reopen consolidated subplans so subplanners can change the values. - `StartCollaboration`: Enter collaboration mode, so you can assign subplans to subplanners. - `EndCollaboration`:  Regain control of the plan, so you can finalize it and put it into operation. ", alias="actionType")
     consolidate_action_payload: ConsolidateActionPayload = Field(alias="consolidateActionPayload")
     __properties: ClassVar[List[str]] = ["actionType", "consolidateActionPayload"]
 

visier_platform_sdk/models/{plan_patch_consolidate_action_request_with_plan_id.py → plan_patch_end_collaboration_action_request.py}

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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
@@ -20,24 +19,23 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List
-from visier_platform_sdk.models.consolidate_action_payload import ConsolidateActionPayload
+from visier_platform_sdk.models.end_collaboration_action_payload import EndCollaborationActionPayload
 from typing import Optional, Set
 from typing_extensions import Self
 
-class PlanPatchConsolidateActionRequestWithPlanId(BaseModel):
+class PlanPatchEndCollaborationActionRequest(BaseModel):
     """
-    PlanPatchConsolidateActionRequestWithPlanId
+    PlanPatchEndCollaborationActionRequest
     """ # noqa: E501
-    action_type: StrictStr = Field(description="The action to perform on the subplan. Valid values: - `Consolidate`: Combine the submitted subplan values into the main plan. - `Reopen`: Reopen consolidated subplans so subplanners can change the values. ", alias="actionType")
-    consolidate_action_payload: ConsolidateActionPayload = Field(alias="consolidateActionPayload")
-    plan_id: StrictStr = Field(description="The `uuid` of the subplan. Required for `PATCH /v1alpha/planning/data/plans`. If you are consolidating subplans, this is the `uuid` of the main plan.", alias="planId")
-    __properties: ClassVar[List[str]] = ["actionType", "consolidateActionPayload", "planId"]
+    action_type: StrictStr = Field(description="The action to perform on the main plan or the subplan, in a specific scenario. Valid values: - `Consolidate`: Combine the submitted subplan values into the main plan. - `Submit`: Send your completed subplan to the plan coordinator for review. - `Reopen`: Reopen consolidated subplans so subplanners can change the values. - `StartCollaboration`: Enter collaboration mode, so you can assign subplans to subplanners. - `EndCollaboration`:  Regain control of the plan, so you can finalize it and put it into operation. ", alias="actionType")
+    end_collaboration_action_payload: EndCollaborationActionPayload = Field(alias="endCollaborationActionPayload")
+    __properties: ClassVar[List[str]] = ["actionType", "endCollaborationActionPayload"]
 
     @field_validator('action_type')
     def action_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['Consolidate']):
-            raise ValueError("must be one of enum values ('Consolidate')")
+        if value not in set(['EndCollaboration']):
+            raise ValueError("must be one of enum values ('EndCollaboration')")
         return value
 
     model_config = ConfigDict(
@@ -58,7 +56,7 @@ class PlanPatchConsolidateActionRequestWithPlanId(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of PlanPatchConsolidateActionRequestWithPlanId from a JSON string"""
+        """Create an instance of PlanPatchEndCollaborationActionRequest from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -79,14 +77,14 @@ class PlanPatchConsolidateActionRequestWithPlanId(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of consolidate_action_payload
-        if self.consolidate_action_payload:
-            _dict['consolidateActionPayload'] = self.consolidate_action_payload.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of end_collaboration_action_payload
+        if self.end_collaboration_action_payload:
+            _dict['endCollaborationActionPayload'] = self.end_collaboration_action_payload.to_dict()
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of PlanPatchConsolidateActionRequestWithPlanId from a dict"""
+        """Create an instance of PlanPatchEndCollaborationActionRequest from a dict"""
         if obj is None:
             return None
 
@@ -95,8 +93,7 @@ class PlanPatchConsolidateActionRequestWithPlanId(BaseModel):
 
         _obj = cls.model_validate({
             "actionType": obj.get("actionType"),
-            "consolidateActionPayload": ConsolidateActionPayload.from_dict(obj["consolidateActionPayload"]) if obj.get("consolidateActionPayload") is not None else None,
-            "planId": obj.get("planId")
+            "endCollaborationActionPayload": EndCollaborationActionPayload.from_dict(obj["endCollaborationActionPayload"]) if obj.get("endCollaborationActionPayload") is not None else None
         })
         return _obj
 

visier_platform_sdk/models/plan_patch_reopen_action_request.py

@@ -5,14 +5,13 @@
 
     Detailed API reference documentation for Visier APIs. Includes all endpoints, headers, path parameters, query parameters, request body schema, response schema, JSON request samples, and JSON response samples.
 
-    The version of the OpenAPI document: 22222222.99201.2050
+    The version of the OpenAPI document: 22222222.99201.2165
     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
@@ -28,7 +27,7 @@ class PlanPatchReopenActionRequest(BaseModel):
     """
     PlanPatchReopenActionRequest
     """ # noqa: E501
-    action_type: StrictStr = Field(description="The action to perform on the subplan. Valid values: - `Consolidate`: Combine the submitted subplan values into the main plan. - `Reopen`: Reopen consolidated subplans so subplanners can change the values. ", alias="actionType")
+    action_type: StrictStr = Field(description="The action to perform on the main plan or the subplan, in a specific scenario. Valid values: - `Consolidate`: Combine the submitted subplan values into the main plan. - `Submit`: Send your completed subplan to the plan coordinator for review. - `Reopen`: Reopen consolidated subplans so subplanners can change the values. - `StartCollaboration`: Enter collaboration mode, so you can assign subplans to subplanners. - `EndCollaboration`:  Regain control of the plan, so you can finalize it and put it into operation. ", alias="actionType")
     reopen_action_payload: ReopenActionPayload = Field(alias="reopenActionPayload")
     __properties: ClassVar[List[str]] = ["actionType", "reopenActionPayload"]
 

visier_platform_sdk/models/plan_patch_start_collaboration_action_request.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.99201.2165
+    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, field_validator
+from typing import Any, ClassVar, Dict, List
+from visier_platform_sdk.models.start_collaboration_action_payload import StartCollaborationActionPayload
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PlanPatchStartCollaborationActionRequest(BaseModel):
+    """
+    PlanPatchStartCollaborationActionRequest
+    """ # noqa: E501
+    action_type: StrictStr = Field(description="The action to perform on the main plan or the subplan, in a specific scenario. Valid values: - `Consolidate`: Combine the submitted subplan values into the main plan. - `Submit`: Send your completed subplan to the plan coordinator for review. - `Reopen`: Reopen consolidated subplans so subplanners can change the values. - `StartCollaboration`: Enter collaboration mode, so you can assign subplans to subplanners. - `EndCollaboration`:  Regain control of the plan, so you can finalize it and put it into operation. ", alias="actionType")
+    start_collaboration_action_payload: StartCollaborationActionPayload = Field(alias="startCollaborationActionPayload")
+    __properties: ClassVar[List[str]] = ["actionType", "startCollaborationActionPayload"]
+
+    @field_validator('action_type')
+    def action_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['StartCollaboration']):
+            raise ValueError("must be one of enum values ('StartCollaboration')")
+        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 PlanPatchStartCollaborationActionRequest 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 start_collaboration_action_payload
+        if self.start_collaboration_action_payload:
+            _dict['startCollaborationActionPayload'] = self.start_collaboration_action_payload.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PlanPatchStartCollaborationActionRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "actionType": obj.get("actionType"),
+            "startCollaborationActionPayload": StartCollaborationActionPayload.from_dict(obj["startCollaborationActionPayload"]) if obj.get("startCollaborationActionPayload") is not None else None
+        })
+        return _obj
+
+