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

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

visier_platform_sdk/api/plan_administration_api.py

@@ -0,0 +1,357 @@
+# 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
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictStr
+from typing_extensions import Annotated
+from visier_platform_sdk.models.plan_scenario_patch_request import PlanScenarioPatchRequest
+from visier_platform_sdk.models.plan_scenario_patch_response import PlanScenarioPatchResponse
+
+from visier_platform_sdk.api_client import ApiClient, RequestSerialized
+from visier_platform_sdk.api_response import ApiResponse
+from visier_platform_sdk.rest import RESTResponseType
+
+
+class PlanAdministrationApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def patch_plan(
+        self,
+        plan_id: Annotated[StrictStr, Field(description="The unique identifier of the main plan or subplan. Use the main plan ID for consolidating, starting collaboration, or ending collaboration. Otherwise, use the subplan ID.")],
+        scenario_id: Annotated[StrictStr, Field(description="The unique identifier of the plan scenario.")],
+        plan_scenario_patch_request: PlanScenarioPatchRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PlanScenarioPatchResponse:
+        """Partially update a subplan
+
+        Make partial changes to existing subplans. The response returns whether each subplan was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition. To retrieve main plan or subplan IDs and scenario IDs, see `GET /v1alpha/planning/model/plans`. If the response includes a `parentPlanUuid`, then the plan is a subplan.   Use `PATCH` to change specific fields in the subplan without affecting omitted fields.    <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
+
+        :param plan_id: The unique identifier of the main plan or subplan. Use the main plan ID for consolidating, starting collaboration, or ending collaboration. Otherwise, use the subplan ID. (required)
+        :type plan_id: str
+        :param scenario_id: The unique identifier of the plan scenario. (required)
+        :type scenario_id: str
+        :param plan_scenario_patch_request: (required)
+        :type plan_scenario_patch_request: PlanScenarioPatchRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._patch_plan_serialize(
+            plan_id=plan_id,
+            scenario_id=scenario_id,
+            plan_scenario_patch_request=plan_scenario_patch_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PlanScenarioPatchResponse",
+            '500': "Status",
+            '400': "ErrorSummary",
+            '404': "ErrorSummary",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def patch_plan_with_http_info(
+        self,
+        plan_id: Annotated[StrictStr, Field(description="The unique identifier of the main plan or subplan. Use the main plan ID for consolidating, starting collaboration, or ending collaboration. Otherwise, use the subplan ID.")],
+        scenario_id: Annotated[StrictStr, Field(description="The unique identifier of the plan scenario.")],
+        plan_scenario_patch_request: PlanScenarioPatchRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PlanScenarioPatchResponse]:
+        """Partially update a subplan
+
+        Make partial changes to existing subplans. The response returns whether each subplan was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition. To retrieve main plan or subplan IDs and scenario IDs, see `GET /v1alpha/planning/model/plans`. If the response includes a `parentPlanUuid`, then the plan is a subplan.   Use `PATCH` to change specific fields in the subplan without affecting omitted fields.    <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
+
+        :param plan_id: The unique identifier of the main plan or subplan. Use the main plan ID for consolidating, starting collaboration, or ending collaboration. Otherwise, use the subplan ID. (required)
+        :type plan_id: str
+        :param scenario_id: The unique identifier of the plan scenario. (required)
+        :type scenario_id: str
+        :param plan_scenario_patch_request: (required)
+        :type plan_scenario_patch_request: PlanScenarioPatchRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._patch_plan_serialize(
+            plan_id=plan_id,
+            scenario_id=scenario_id,
+            plan_scenario_patch_request=plan_scenario_patch_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PlanScenarioPatchResponse",
+            '500': "Status",
+            '400': "ErrorSummary",
+            '404': "ErrorSummary",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def patch_plan_without_preload_content(
+        self,
+        plan_id: Annotated[StrictStr, Field(description="The unique identifier of the main plan or subplan. Use the main plan ID for consolidating, starting collaboration, or ending collaboration. Otherwise, use the subplan ID.")],
+        scenario_id: Annotated[StrictStr, Field(description="The unique identifier of the plan scenario.")],
+        plan_scenario_patch_request: PlanScenarioPatchRequest,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Partially update a subplan
+
+        Make partial changes to existing subplans. The response returns whether each subplan was successfully patched or not. When patching objects, we recommend that you first retrieve the object definition using `GET`. You can use the `GET` response in your `PATCH` request definition. To retrieve main plan or subplan IDs and scenario IDs, see `GET /v1alpha/planning/model/plans`. If the response includes a `parentPlanUuid`, then the plan is a subplan.   Use `PATCH` to change specific fields in the subplan without affecting omitted fields.    <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>
+
+        :param plan_id: The unique identifier of the main plan or subplan. Use the main plan ID for consolidating, starting collaboration, or ending collaboration. Otherwise, use the subplan ID. (required)
+        :type plan_id: str
+        :param scenario_id: The unique identifier of the plan scenario. (required)
+        :type scenario_id: str
+        :param plan_scenario_patch_request: (required)
+        :type plan_scenario_patch_request: PlanScenarioPatchRequest
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._patch_plan_serialize(
+            plan_id=plan_id,
+            scenario_id=scenario_id,
+            plan_scenario_patch_request=plan_scenario_patch_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PlanScenarioPatchResponse",
+            '500': "Status",
+            '400': "ErrorSummary",
+            '404': "ErrorSummary",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _patch_plan_serialize(
+        self,
+        plan_id,
+        scenario_id,
+        plan_scenario_patch_request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if plan_id is not None:
+            _path_params['planId'] = plan_id
+        if scenario_id is not None:
+            _path_params['scenarioId'] = scenario_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if plan_scenario_patch_request is not None:
+            _body_params = plan_scenario_patch_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'CookieAuth', 
+            'ApiKeyAuth', 
+            'OAuth2Auth', 
+            'OAuth2Auth', 
+            'BearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='PATCH',
+            resource_path='/v1alpha/planning/data/plans/{planId}/scenarios/{scenarioId}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

visier_platform_sdk/api/{planning_data_load_api.py → plan_data_load_api.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.21494
+    The version of the OpenAPI document: 22222222.99200.22144
     Contact: alpine@visier.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -28,7 +28,7 @@ from visier_platform_sdk.api_response import ApiResponse
 from visier_platform_sdk.rest import RESTResponseType
 
 
-class PlanningDataLoadApi:
+class PlanDataLoadApi:
     """NOTE: This class is auto generated by OpenAPI Generator
     Ref: https://openapi-generator.tech
 
@@ -42,7 +42,7 @@ class PlanningDataLoadApi:
 
 
     @validate_call
-    def plan_data_load_plan_data_upload(
+    def plan_data_upload(
         self,
         plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")],
         scenario_id: Annotated[StrictStr, Field(description="The unique identifier of the plan scenario to load data into.")],
@@ -104,7 +104,7 @@ class PlanningDataLoadApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._plan_data_load_plan_data_upload_serialize(
+        _param = self._plan_data_upload_serialize(
             plan_id=plan_id,
             scenario_id=scenario_id,
             calculation=calculation,
@@ -133,7 +133,7 @@ class PlanningDataLoadApi:
 
 
     @validate_call
-    def plan_data_load_plan_data_upload_with_http_info(
+    def plan_data_upload_with_http_info(
         self,
         plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")],
         scenario_id: Annotated[StrictStr, Field(description="The unique identifier of the plan scenario to load data into.")],
@@ -195,7 +195,7 @@ class PlanningDataLoadApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._plan_data_load_plan_data_upload_serialize(
+        _param = self._plan_data_upload_serialize(
             plan_id=plan_id,
             scenario_id=scenario_id,
             calculation=calculation,
@@ -224,7 +224,7 @@ class PlanningDataLoadApi:
 
 
     @validate_call
-    def plan_data_load_plan_data_upload_without_preload_content(
+    def plan_data_upload_without_preload_content(
         self,
         plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")],
         scenario_id: Annotated[StrictStr, Field(description="The unique identifier of the plan scenario to load data into.")],
@@ -286,7 +286,7 @@ class PlanningDataLoadApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._plan_data_load_plan_data_upload_serialize(
+        _param = self._plan_data_upload_serialize(
             plan_id=plan_id,
             scenario_id=scenario_id,
             calculation=calculation,
@@ -310,7 +310,7 @@ class PlanningDataLoadApi:
         return response_data.response
 
 
-    def _plan_data_load_plan_data_upload_serialize(
+    def _plan_data_upload_serialize(
         self,
         plan_id,
         scenario_id,
@@ -399,7 +399,7 @@ class PlanningDataLoadApi:
 
         return self.api_client.param_serialize(
             method='PATCH',
-            resource_path='/v1alpha/planning/data/plans/{planId}/scenarios/{scenarioId}',
+            resource_path='/v1alpha/planning/data/plans/{planId}/scenarios/{scenarioId}/cells',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -416,7 +416,7 @@ class PlanningDataLoadApi:
 
 
     @validate_call
-    def plan_data_load_plan_row_data_load(
+    def plan_row_data_load(
         self,
         plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")],
         method: Annotated[Optional[StrictStr], Field(description="Sets how to validate the data being loaded into Visier. Valid values:   - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data.   - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan.   - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default.")] = None,
@@ -469,7 +469,7 @@ class PlanningDataLoadApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._plan_data_load_plan_row_data_load_serialize(
+        _param = self._plan_row_data_load_serialize(
             plan_id=plan_id,
             method=method,
             target_tenant_id=target_tenant_id,
@@ -495,7 +495,7 @@ class PlanningDataLoadApi:
 
 
     @validate_call
-    def plan_data_load_plan_row_data_load_with_http_info(
+    def plan_row_data_load_with_http_info(
         self,
         plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")],
         method: Annotated[Optional[StrictStr], Field(description="Sets how to validate the data being loaded into Visier. Valid values:   - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data.   - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan.   - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default.")] = None,
@@ -548,7 +548,7 @@ class PlanningDataLoadApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._plan_data_load_plan_row_data_load_serialize(
+        _param = self._plan_row_data_load_serialize(
             plan_id=plan_id,
             method=method,
             target_tenant_id=target_tenant_id,
@@ -574,7 +574,7 @@ class PlanningDataLoadApi:
 
 
     @validate_call
-    def plan_data_load_plan_row_data_load_without_preload_content(
+    def plan_row_data_load_without_preload_content(
         self,
         plan_id: Annotated[StrictStr, Field(description="The unique identifier of the plan.")],
         method: Annotated[Optional[StrictStr], Field(description="Sets how to validate the data being loaded into Visier. Valid values:   - **VALIDATE**: Runs a test load through all the validation steps without putting the data into the plan. Use `VALIDATE` to find any errors before using `STRICT_UPLOAD` to load the data.   - **SKIP_ERRORS**: Loads all data without errors into the plan. Any rows with errors are excluded from the update to the plan.   - **STRICT_UPLOAD**: Loads data into the plan if there are no errors in any row. If there are errors, the load fails. This is the default.")] = None,
@@ -627,7 +627,7 @@ class PlanningDataLoadApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._plan_data_load_plan_row_data_load_serialize(
+        _param = self._plan_row_data_load_serialize(
             plan_id=plan_id,
             method=method,
             target_tenant_id=target_tenant_id,
@@ -648,7 +648,7 @@ class PlanningDataLoadApi:
         return response_data.response
 
 
-    def _plan_data_load_plan_row_data_load_serialize(
+    def _plan_row_data_load_serialize(
         self,
         plan_id,
         method,

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

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