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

visier_platform_sdk/models/plan_data_load_change_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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/plan_data_load_change_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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/plan_data_load_error_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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/plan_data_upload_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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/plan_info_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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -19,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
@@ -31,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,
@@ -81,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
@@ -97,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,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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/plan_parameter_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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/plan_parameter_value_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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/plan_patch_consolidate_action_request.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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -27,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,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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -19,25 +19,23 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List
-from uuid import UUID
-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: UUID = 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,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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -27,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
+
+

visier_platform_sdk/models/{plan_patch_reopen_action_request_with_plan_id.py → plan_patch_submit_action_request.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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -19,25 +19,23 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List
-from uuid import UUID
-from visier_platform_sdk.models.reopen_action_payload import ReopenActionPayload
+from visier_platform_sdk.models.submit_action_payload import SubmitActionPayload
 from typing import Optional, Set
 from typing_extensions import Self
 
-class PlanPatchReopenActionRequestWithPlanId(BaseModel):
+class PlanPatchSubmitActionRequest(BaseModel):
     """
-    PlanPatchReopenActionRequestWithPlanId
+    PlanPatchSubmitActionRequest
     """ # 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")
-    reopen_action_payload: ReopenActionPayload = Field(alias="reopenActionPayload")
-    plan_id: UUID = 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", "reopenActionPayload", "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")
+    submit_action_payload: SubmitActionPayload = Field(alias="submitActionPayload")
+    __properties: ClassVar[List[str]] = ["actionType", "submitActionPayload"]
 
     @field_validator('action_type')
     def action_type_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['Reopen']):
-            raise ValueError("must be one of enum values ('Reopen')")
+        if value not in set(['Submit']):
+            raise ValueError("must be one of enum values ('Submit')")
         return value
 
     model_config = ConfigDict(
@@ -58,7 +56,7 @@ class PlanPatchReopenActionRequestWithPlanId(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of PlanPatchReopenActionRequestWithPlanId from a JSON string"""
+        """Create an instance of PlanPatchSubmitActionRequest from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -79,14 +77,14 @@ class PlanPatchReopenActionRequestWithPlanId(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of reopen_action_payload
-        if self.reopen_action_payload:
-            _dict['reopenActionPayload'] = self.reopen_action_payload.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of submit_action_payload
+        if self.submit_action_payload:
+            _dict['submitActionPayload'] = self.submit_action_payload.to_dict()
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of PlanPatchReopenActionRequestWithPlanId from a dict"""
+        """Create an instance of PlanPatchSubmitActionRequest from a dict"""
         if obj is None:
             return None
 
@@ -95,8 +93,7 @@ class PlanPatchReopenActionRequestWithPlanId(BaseModel):
 
         _obj = cls.model_validate({
             "actionType": obj.get("actionType"),
-            "reopenActionPayload": ReopenActionPayload.from_dict(obj["reopenActionPayload"]) if obj.get("reopenActionPayload") is not None else None,
-            "planId": obj.get("planId")
+            "submitActionPayload": SubmitActionPayload.from_dict(obj["submitActionPayload"]) if obj.get("submitActionPayload") is not None else None
         })
         return _obj
 

visier_platform_sdk/models/plan_row_data_load_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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

visier_platform_sdk/models/{plan_patch_action_result.py → plan_scenario_patch_action_result.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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -23,11 +23,11 @@ from visier_platform_sdk.models.error_summary import ErrorSummary
 from typing import Optional, Set
 from typing_extensions import Self
 
-class PlanPatchActionResult(BaseModel):
+class PlanScenarioPatchActionResult(BaseModel):
     """
-    The result of the action taken on the subplan.
+    The result of the action taken on the main plan or subplan.
     """ # noqa: E501
-    plan_id: Optional[StrictStr] = Field(default=None, description="The UUID of the subplan.", alias="planId")
+    plan_id: Optional[StrictStr] = Field(default=None, description="The UUID of the main plan or subplan.", alias="planId")
     success: Optional[StrictBool] = Field(default=None, description="If `true`, the action was successful.")
     error: Optional[ErrorSummary] = Field(default=None, description="The error details of the unsuccessful action.")
     __properties: ClassVar[List[str]] = ["planId", "success", "error"]
@@ -50,7 +50,7 @@ class PlanPatchActionResult(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of PlanPatchActionResult from a JSON string"""
+        """Create an instance of PlanScenarioPatchActionResult from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -78,7 +78,7 @@ class PlanPatchActionResult(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of PlanPatchActionResult from a dict"""
+        """Create an instance of PlanScenarioPatchActionResult from a dict"""
         if obj is None:
             return None
 

visier_platform_sdk/models/{plan_patch_request.py → plan_scenario_patch_request.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.99201.2145
+    The version of the OpenAPI document: 22222222.99201.2165
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -18,23 +18,32 @@ import pprint
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
 from typing import Any, List, Optional
 from visier_platform_sdk.models.plan_patch_consolidate_action_request import PlanPatchConsolidateActionRequest
+from visier_platform_sdk.models.plan_patch_end_collaboration_action_request import PlanPatchEndCollaborationActionRequest
 from visier_platform_sdk.models.plan_patch_reopen_action_request import PlanPatchReopenActionRequest
+from visier_platform_sdk.models.plan_patch_start_collaboration_action_request import PlanPatchStartCollaborationActionRequest
+from visier_platform_sdk.models.plan_patch_submit_action_request import PlanPatchSubmitActionRequest
 from pydantic import StrictStr, Field
 from typing import Union, List, Set, Optional, Dict
 from typing_extensions import Literal, Self
 
-PLANPATCHREQUEST_ONE_OF_SCHEMAS = ["PlanPatchConsolidateActionRequest", "PlanPatchReopenActionRequest"]
+PLANSCENARIOPATCHREQUEST_ONE_OF_SCHEMAS = ["PlanPatchConsolidateActionRequest", "PlanPatchEndCollaborationActionRequest", "PlanPatchReopenActionRequest", "PlanPatchStartCollaborationActionRequest", "PlanPatchSubmitActionRequest"]
 
-class PlanPatchRequest(BaseModel):
+class PlanScenarioPatchRequest(BaseModel):
     """
-    If reopening a subplan, this is the subplan to update. If consolidating subplans, this is the main plan to update.
+    If consolidating subplans, starting collaboration, or ending collaboration, this is the main plan to update. Otherwise, this is the subplan to update.
     """
     # data type: PlanPatchConsolidateActionRequest
     oneof_schema_1_validator: Optional[PlanPatchConsolidateActionRequest] = None
+    # data type: PlanPatchSubmitActionRequest
+    oneof_schema_2_validator: Optional[PlanPatchSubmitActionRequest] = None
     # data type: PlanPatchReopenActionRequest
-    oneof_schema_2_validator: Optional[PlanPatchReopenActionRequest] = None
-    actual_instance: Optional[Union[PlanPatchConsolidateActionRequest, PlanPatchReopenActionRequest]] = None
-    one_of_schemas: Set[str] = { "PlanPatchConsolidateActionRequest", "PlanPatchReopenActionRequest" }
+    oneof_schema_3_validator: Optional[PlanPatchReopenActionRequest] = None
+    # data type: PlanPatchStartCollaborationActionRequest
+    oneof_schema_4_validator: Optional[PlanPatchStartCollaborationActionRequest] = None
+    # data type: PlanPatchEndCollaborationActionRequest
+    oneof_schema_5_validator: Optional[PlanPatchEndCollaborationActionRequest] = None
+    actual_instance: Optional[Union[PlanPatchConsolidateActionRequest, PlanPatchEndCollaborationActionRequest, PlanPatchReopenActionRequest, PlanPatchStartCollaborationActionRequest, PlanPatchSubmitActionRequest]] = None
+    one_of_schemas: Set[str] = { "PlanPatchConsolidateActionRequest", "PlanPatchEndCollaborationActionRequest", "PlanPatchReopenActionRequest", "PlanPatchStartCollaborationActionRequest", "PlanPatchSubmitActionRequest" }
 
     model_config = ConfigDict(
         validate_assignment=True,
@@ -57,7 +66,7 @@ class PlanPatchRequest(BaseModel):
 
     @field_validator('actual_instance')
     def actual_instance_must_validate_oneof(cls, v):
-        instance = PlanPatchRequest.model_construct()
+        instance = PlanScenarioPatchRequest.model_construct()
         error_messages = []
         match = 0
         # validate data type: PlanPatchConsolidateActionRequest
@@ -65,17 +74,32 @@ class PlanPatchRequest(BaseModel):
             error_messages.append(f"Error! Input type `{type(v)}` is not `PlanPatchConsolidateActionRequest`")
         else:
             match += 1
+        # validate data type: PlanPatchSubmitActionRequest
+        if not isinstance(v, PlanPatchSubmitActionRequest):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PlanPatchSubmitActionRequest`")
+        else:
+            match += 1
         # validate data type: PlanPatchReopenActionRequest
         if not isinstance(v, PlanPatchReopenActionRequest):
             error_messages.append(f"Error! Input type `{type(v)}` is not `PlanPatchReopenActionRequest`")
         else:
             match += 1
+        # validate data type: PlanPatchStartCollaborationActionRequest
+        if not isinstance(v, PlanPatchStartCollaborationActionRequest):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PlanPatchStartCollaborationActionRequest`")
+        else:
+            match += 1
+        # validate data type: PlanPatchEndCollaborationActionRequest
+        if not isinstance(v, PlanPatchEndCollaborationActionRequest):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PlanPatchEndCollaborationActionRequest`")
+        else:
+            match += 1
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when setting `actual_instance` in PlanPatchRequest with oneOf schemas: PlanPatchConsolidateActionRequest, PlanPatchReopenActionRequest. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when setting `actual_instance` in PlanScenarioPatchRequest with oneOf schemas: PlanPatchConsolidateActionRequest, PlanPatchEndCollaborationActionRequest, PlanPatchReopenActionRequest, PlanPatchStartCollaborationActionRequest, PlanPatchSubmitActionRequest. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when setting `actual_instance` in PlanPatchRequest with oneOf schemas: PlanPatchConsolidateActionRequest, PlanPatchReopenActionRequest. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting `actual_instance` in PlanScenarioPatchRequest with oneOf schemas: PlanPatchConsolidateActionRequest, PlanPatchEndCollaborationActionRequest, PlanPatchReopenActionRequest, PlanPatchStartCollaborationActionRequest, PlanPatchSubmitActionRequest. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -96,19 +120,37 @@ class PlanPatchRequest(BaseModel):
             match += 1
         except (ValidationError, ValueError) as e:
             error_messages.append(str(e))
+        # deserialize data into PlanPatchSubmitActionRequest
+        try:
+            instance.actual_instance = PlanPatchSubmitActionRequest.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
         # deserialize data into PlanPatchReopenActionRequest
         try:
             instance.actual_instance = PlanPatchReopenActionRequest.from_json(json_str)
             match += 1
         except (ValidationError, ValueError) as e:
             error_messages.append(str(e))
+        # deserialize data into PlanPatchStartCollaborationActionRequest
+        try:
+            instance.actual_instance = PlanPatchStartCollaborationActionRequest.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into PlanPatchEndCollaborationActionRequest
+        try:
+            instance.actual_instance = PlanPatchEndCollaborationActionRequest.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
 
         if match > 1:
             # more than 1 match
-            raise ValueError("Multiple matches found when deserializing the JSON string into PlanPatchRequest with oneOf schemas: PlanPatchConsolidateActionRequest, PlanPatchReopenActionRequest. Details: " + ", ".join(error_messages))
+            raise ValueError("Multiple matches found when deserializing the JSON string into PlanScenarioPatchRequest with oneOf schemas: PlanPatchConsolidateActionRequest, PlanPatchEndCollaborationActionRequest, PlanPatchReopenActionRequest, PlanPatchStartCollaborationActionRequest, PlanPatchSubmitActionRequest. Details: " + ", ".join(error_messages))
         elif match == 0:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into PlanPatchRequest with oneOf schemas: PlanPatchConsolidateActionRequest, PlanPatchReopenActionRequest. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into PlanScenarioPatchRequest with oneOf schemas: PlanPatchConsolidateActionRequest, PlanPatchEndCollaborationActionRequest, PlanPatchReopenActionRequest, PlanPatchStartCollaborationActionRequest, PlanPatchSubmitActionRequest. Details: " + ", ".join(error_messages))
         else:
             return instance
 
@@ -122,7 +164,7 @@ class PlanPatchRequest(BaseModel):
         else:
             return json.dumps(self.actual_instance)
 
-    def to_dict(self) -> Optional[Union[Dict[str, Any], PlanPatchConsolidateActionRequest, PlanPatchReopenActionRequest]]:
+    def to_dict(self) -> Optional[Union[Dict[str, Any], PlanPatchConsolidateActionRequest, PlanPatchEndCollaborationActionRequest, PlanPatchReopenActionRequest, PlanPatchStartCollaborationActionRequest, PlanPatchSubmitActionRequest]]:
         """Returns the dict representation of the actual instance"""
         if self.actual_instance is None:
             return None