visier-platform-sdk 22222222.99201.1914b1__py3-none-any.whl → 22222222.99201.1914b6__py3-none-any.whl

visier_platform_sdk/models/dp_job_cancellation_result_dto.py

@@ -1,110 +0,0 @@
-# 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.1914
-    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, Optional
-from typing import Optional, Set
-from typing_extensions import Self
-
-class DpJobCancellationResultDTO(BaseModel):
-    """
-    DpJobCancellationResultDTO
-    """ # noqa: E501
-    tenant_code: Optional[StrictStr] = Field(default=None, description="The analytic tenant whose job the cancel operation was conducted for.", alias="tenantCode")
-    job_id: Optional[StrictStr] = Field(default=None, description="The job ID of the job that the cancel operation was conducted for.", alias="jobId")
-    job_type: Optional[StrictStr] = Field(default=None, description="The job type associated with the job ID.", alias="jobType")
-    parent_job_id: Optional[StrictStr] = Field(default=None, description="If applicable, the job ID of the job that spawned the given job.", alias="parentJobId")
-    cancel_status: Optional[StrictStr] = Field(default=None, description="The status of the cancellation.", alias="cancelStatus")
-    job_status: Optional[StrictStr] = Field(default=None, description="The job status after the cancel operation. If successful, the status is either Cancelled or Cancelling.", alias="jobStatus")
-    message: Optional[StrictStr] = Field(default=None, description="If applicable, the message explains what errors occurred while cancelling the jobs.")
-    __properties: ClassVar[List[str]] = ["tenantCode", "jobId", "jobType", "parentJobId", "cancelStatus", "jobStatus", "message"]
-
-    @field_validator('cancel_status')
-    def cancel_status_validate_enum(cls, value):
-        """Validates the enum"""
-        if value is None:
-            return value
-
-        if value not in set(['CANCEL_FAILED', 'CANCEL_SUCCEEDED']):
-            raise ValueError("must be one of enum values ('CANCEL_FAILED', 'CANCEL_SUCCEEDED')")
-        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 DpJobCancellationResultDTO 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 DpJobCancellationResultDTO from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "tenantCode": obj.get("tenantCode"),
-            "jobId": obj.get("jobId"),
-            "jobType": obj.get("jobType"),
-            "parentJobId": obj.get("parentJobId"),
-            "cancelStatus": obj.get("cancelStatus"),
-            "jobStatus": obj.get("jobStatus"),
-            "message": obj.get("message")
-        })
-        return _obj
-
-

visier_platform_sdk/models/dp_job_cancellation_results_dto.py

@@ -1,96 +0,0 @@
-# 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.1914
-    Contact: alpine@visier.com
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from pydantic import BaseModel, ConfigDict, Field
-from typing import Any, ClassVar, Dict, List, Optional
-from visier_platform_sdk.models.dp_job_cancellation_result_dto import DpJobCancellationResultDTO
-from typing import Optional, Set
-from typing_extensions import Self
-
-class DpJobCancellationResultsDTO(BaseModel):
-    """
-    DpJobCancellationResultsDTO
-    """ # noqa: E501
-    job_cancellation_results: Optional[List[DpJobCancellationResultDTO]] = Field(default=None, description="A list of objects representing the job cancellation results.", alias="jobCancellationResults")
-    __properties: ClassVar[List[str]] = ["jobCancellationResults"]
-
-    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 DpJobCancellationResultsDTO from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
-
-        This has the following differences from calling pydantic's
-        `self.model_dump(by_alias=True)`:
-
-        * `None` is only added to the output dict for nullable fields that
-          were set at model initialization. Other fields with value `None`
-          are ignored.
-        """
-        excluded_fields: Set[str] = set([
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        # override the default output from pydantic by calling `to_dict()` of each item in job_cancellation_results (list)
-        _items = []
-        if self.job_cancellation_results:
-            for _item_job_cancellation_results in self.job_cancellation_results:
-                if _item_job_cancellation_results:
-                    _items.append(_item_job_cancellation_results.to_dict())
-            _dict['jobCancellationResults'] = _items
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of DpJobCancellationResultsDTO from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "jobCancellationResults": [DpJobCancellationResultDTO.from_dict(_item) for _item in obj["jobCancellationResults"]] if obj.get("jobCancellationResults") is not None else None
-        })
-        return _obj
-
-

visier_platform_sdk/models/google_protobuf_any.py

@@ -1,101 +0,0 @@
-# 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.1914
-    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 GoogleProtobufAny(BaseModel):
-    """
-    Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
-    """ # noqa: E501
-    type: Optional[StrictStr] = Field(default=None, description="The type of the serialized message.", alias="@type")
-    additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["@type"]
-
-    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 GoogleProtobufAny 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.
-        * Fields in `self.additional_properties` are added to the output dict.
-        """
-        excluded_fields: Set[str] = set([
-            "additional_properties",
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        # puts key-value pairs in additional_properties in the top level
-        if self.additional_properties is not None:
-            for _key, _value in self.additional_properties.items():
-                _dict[_key] = _value
-
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of GoogleProtobufAny from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "@type": obj.get("@type")
-        })
-        # store additional fields in additional_properties
-        for _key in obj.keys():
-            if _key not in cls.__properties:
-                _obj.additional_properties[_key] = obj.get(_key)
-
-        return _obj
-
-

visier_platform_sdk/models/planning_get_plan_list_response_dto.py

@@ -1,98 +0,0 @@
-# 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.1914
-    Contact: alpine@visier.com
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from pydantic import BaseModel, ConfigDict, Field, StrictInt
-from typing import Any, ClassVar, Dict, List, Optional
-from visier_platform_sdk.models.planning_plan_info_dto import PlanningPlanInfoDTO
-from typing import Optional, Set
-from typing_extensions import Self
-
-class PlanningGetPlanListResponseDTO(BaseModel):
-    """
-    A collection of plans.
-    """ # noqa: E501
-    plans: Optional[List[PlanningPlanInfoDTO]] = Field(default=None, description="A list of plans accessible to the user.")
-    page: Optional[StrictInt] = Field(default=None, description="The current page number of results that the user is viewing.")
-    __properties: ClassVar[List[str]] = ["plans", "page"]
-
-    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 PlanningGetPlanListResponseDTO from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
-
-        This has the following differences from calling pydantic's
-        `self.model_dump(by_alias=True)`:
-
-        * `None` is only added to the output dict for nullable fields that
-          were set at model initialization. Other fields with value `None`
-          are ignored.
-        """
-        excluded_fields: Set[str] = set([
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        # override the default output from pydantic by calling `to_dict()` of each item in plans (list)
-        _items = []
-        if self.plans:
-            for _item_plans in self.plans:
-                if _item_plans:
-                    _items.append(_item_plans.to_dict())
-            _dict['plans'] = _items
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of PlanningGetPlanListResponseDTO from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "plans": [PlanningPlanInfoDTO.from_dict(_item) for _item in obj["plans"]] if obj.get("plans") is not None else None,
-            "page": obj.get("page")
-        })
-        return _obj
-
-

visier_platform_sdk/models/planning_plan_data_load_error_dto.py

@@ -1,92 +0,0 @@
-# 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.1914
-    Contact: alpine@visier.com
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
-from typing import Optional, Set
-from typing_extensions import Self
-
-class PlanningPlanDataLoadErrorDTO(BaseModel):
-    """
-    An error encountered while loading plan data.
-    """ # noqa: E501
-    row: Optional[StrictInt] = Field(default=None, description="The row in the file that caused the error.")
-    rci: Optional[StrictStr] = Field(default=None, description="An error code that can be provided to Visier Support to help investigate your issue.")
-    error_message: Optional[StrictStr] = Field(default=None, description="Information regarding the error and any actions that you could take to load the data correctly.", alias="errorMessage")
-    __properties: ClassVar[List[str]] = ["row", "rci", "errorMessage"]
-
-    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 PlanningPlanDataLoadErrorDTO 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 PlanningPlanDataLoadErrorDTO from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "row": obj.get("row"),
-            "rci": obj.get("rci"),
-            "errorMessage": obj.get("errorMessage")
-        })
-        return _obj
-
-

visier_platform_sdk/models/planning_plan_info_dto.py

@@ -1,106 +0,0 @@
-# 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.1914
-    Contact: alpine@visier.com
-    Generated by OpenAPI Generator (https://openapi-generator.tech)
-
-    Do not edit the class manually.
-"""  # noqa: E501
-
-
-from __future__ import annotations
-import pprint
-import re  # noqa: F401
-import json
-
-from pydantic import BaseModel, ConfigDict, Field, StrictStr
-from typing import Any, ClassVar, Dict, List, Optional
-from visier_platform_sdk.models.planning_scenario_info_dto import PlanningScenarioInfoDTO
-from typing import Optional, Set
-from typing_extensions import Self
-
-class PlanningPlanInfoDTO(BaseModel):
-    """
-    Information about a plan and its scenarios.
-    """ # noqa: E501
-    uuid: Optional[StrictStr] = Field(default=None, description="The UUID of the plan.")
-    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[PlanningScenarioInfoDTO]] = Field(default=None, description="Information about the plan's scenarios.")
-    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"]
-
-    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 PlanningPlanInfoDTO from a JSON string"""
-        return cls.from_dict(json.loads(json_str))
-
-    def to_dict(self) -> Dict[str, Any]:
-        """Return the dictionary representation of the model using alias.
-
-        This has the following differences from calling pydantic's
-        `self.model_dump(by_alias=True)`:
-
-        * `None` is only added to the output dict for nullable fields that
-          were set at model initialization. Other fields with value `None`
-          are ignored.
-        """
-        excluded_fields: Set[str] = set([
-        ])
-
-        _dict = self.model_dump(
-            by_alias=True,
-            exclude=excluded_fields,
-            exclude_none=True,
-        )
-        # override the default output from pydantic by calling `to_dict()` of each item in scenarios (list)
-        _items = []
-        if self.scenarios:
-            for _item_scenarios in self.scenarios:
-                if _item_scenarios:
-                    _items.append(_item_scenarios.to_dict())
-            _dict['scenarios'] = _items
-        return _dict
-
-    @classmethod
-    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of PlanningPlanInfoDTO from a dict"""
-        if obj is None:
-            return None
-
-        if not isinstance(obj, dict):
-            return cls.model_validate(obj)
-
-        _obj = cls.model_validate({
-            "uuid": obj.get("uuid"),
-            "displayName": obj.get("displayName"),
-            "modelId": obj.get("modelId"),
-            "scenarios": [PlanningScenarioInfoDTO.from_dict(_item) for _item in obj["scenarios"]] if obj.get("scenarios") is not None else None,
-            "parentPlanUuid": obj.get("parentPlanUuid"),
-            "currencyCode": obj.get("currencyCode")
-        })
-        return _obj
-
-