terra-scientific-pipelines-service-api-client 1.0.15__tar.gz → 1.0.17__tar.gz

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: terra-scientific-pipelines-service-api-client
-Version: 1.0.15
+Version: 1.0.17
 Summary: Terra Scientific Pipelines Service
 Home-page: 
 Author: OpenAPI Generator community

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/README.md

@@ -4,7 +4,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 1.0.15
+- Package version: 1.0.17
 - Generator version: 7.9.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -128,6 +128,7 @@ Class | Method | HTTP request | Description
  - [JobReport](docs/JobReport.md)
  - [JobResult](docs/JobResult.md)
  - [Pipeline](docs/Pipeline.md)
+ - [PipelineQuota](docs/PipelineQuota.md)
  - [PipelineRun](docs/PipelineRun.md)
  - [PipelineRunReport](docs/PipelineRunReport.md)
  - [PipelineUserProvidedInputDefinition](docs/PipelineUserProvidedInputDefinition.md)

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "teaspoons_client"
-version = "1.0.15"
+version = "1.0.17"
 description = "Terra Scientific Pipelines Service"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "NoLicense"

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/setup.py

@@ -21,7 +21,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "terra-scientific-pipelines-service-api-client"
-VERSION = "1.0.15"
+VERSION = "1.0.17"
 PYTHON_REQUIRES = ">= 3.8"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 3.0.0",

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/teaspoons_client/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.0.15"
+__version__ = "1.0.17"
 
 # import apis into sdk package
 from teaspoons_client.api.admin_api import AdminApi
@@ -48,6 +48,7 @@ from teaspoons_client.models.job_control import JobControl
 from teaspoons_client.models.job_report import JobReport
 from teaspoons_client.models.job_result import JobResult
 from teaspoons_client.models.pipeline import Pipeline
+from teaspoons_client.models.pipeline_quota import PipelineQuota
 from teaspoons_client.models.pipeline_run import PipelineRun
 from teaspoons_client.models.pipeline_run_report import PipelineRunReport
 from teaspoons_client.models.pipeline_user_provided_input_definition import PipelineUserProvidedInputDefinition

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/teaspoons_client/api_client.py

@@ -90,7 +90,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'terra-scientific-pipelines-service-api-client/1.0.15/python'
+        self.user_agent = 'terra-scientific-pipelines-service-api-client/1.0.17/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/teaspoons_client/configuration.py

@@ -399,7 +399,7 @@ class Configuration:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0.0\n"\
-               "SDK Package Version: 1.0.15".\
+               "SDK Package Version: 1.0.17".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/teaspoons_client/models/__init__.py

@@ -26,6 +26,7 @@ from teaspoons_client.models.job_control import JobControl
 from teaspoons_client.models.job_report import JobReport
 from teaspoons_client.models.job_result import JobResult
 from teaspoons_client.models.pipeline import Pipeline
+from teaspoons_client.models.pipeline_quota import PipelineQuota
 from teaspoons_client.models.pipeline_run import PipelineRun
 from teaspoons_client.models.pipeline_run_report import PipelineRunReport
 from teaspoons_client.models.pipeline_user_provided_input_definition import PipelineUserProvidedInputDefinition

terra_scientific_pipelines_service_api_client-1.0.17/teaspoons_client/models/pipeline_quota.py

@@ -0,0 +1,93 @@
+# coding: utf-8
+
+"""
+    Terra Scientific Pipelines Service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.0
+    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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PipelineQuota(BaseModel):
+    """
+    The quota for the pipeline. 
+    """ # noqa: E501
+    pipeline_name: StrictStr = Field(description="The identifier string for the Pipeline. ", alias="pipelineName")
+    default_quota: StrictInt = Field(description="Default quota for the pipeline. ", alias="defaultQuota")
+    min_quota_consumed: StrictInt = Field(description="The minimum quota consumed per run. ", alias="minQuotaConsumed")
+    quota_units: StrictStr = Field(description="Units for pipeline quota ", alias="quotaUnits")
+    __properties: ClassVar[List[str]] = ["pipelineName", "defaultQuota", "minQuotaConsumed", "quotaUnits"]
+
+    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 PipelineQuota 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 PipelineQuota from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "pipelineName": obj.get("pipelineName"),
+            "defaultQuota": obj.get("defaultQuota"),
+            "minQuotaConsumed": obj.get("minQuotaConsumed"),
+            "quotaUnits": obj.get("quotaUnits")
+        })
+        return _obj
+
+

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/teaspoons_client/models/pipeline_run.py

@@ -28,12 +28,13 @@ class PipelineRun(BaseModel):
     """ # noqa: E501
     job_id: StrictStr = Field(description="Required unique identifier (UUID) for a job. ", alias="jobId")
     pipeline_name: StrictStr = Field(description="The identifier string for the Pipeline. ", alias="pipelineName")
+    pipeline_version: Optional[StrictInt] = Field(default=None, description="An identifier Integer for the Pipeline Version. ", alias="pipelineVersion")
     status: StrictStr = Field(description="The current status of the pipeline run. ")
     description: Optional[StrictStr] = Field(default=None, description="The user-provided description for the pipeline run. ")
     time_submitted: StrictStr = Field(description="The time the job was submitted. ", alias="timeSubmitted")
     time_completed: Optional[StrictStr] = Field(default=None, description="The time the job was completed. ", alias="timeCompleted")
     quota_consumed: Optional[StrictInt] = Field(default=None, description="Quota consumed by the user ", alias="quotaConsumed")
-    __properties: ClassVar[List[str]] = ["jobId", "pipelineName", "status", "description", "timeSubmitted", "timeCompleted", "quotaConsumed"]
+    __properties: ClassVar[List[str]] = ["jobId", "pipelineName", "pipelineVersion", "status", "description", "timeSubmitted", "timeCompleted", "quotaConsumed"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -88,6 +89,7 @@ class PipelineRun(BaseModel):
         _obj = cls.model_validate({
             "jobId": obj.get("jobId"),
             "pipelineName": obj.get("pipelineName"),
+            "pipelineVersion": obj.get("pipelineVersion"),
             "status": obj.get("status"),
             "description": obj.get("description"),
             "timeSubmitted": obj.get("timeSubmitted"),

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/teaspoons_client/models/pipeline_with_details.py

@@ -19,6 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List
+from teaspoons_client.models.pipeline_quota import PipelineQuota
 from teaspoons_client.models.pipeline_user_provided_input_definition import PipelineUserProvidedInputDefinition
 from typing import Optional, Set
 from typing_extensions import Self
@@ -33,7 +34,8 @@ class PipelineWithDetails(BaseModel):
     description: StrictStr = Field(description="The description for the Pipeline. ")
     type: StrictStr = Field(description="The general type of the Pipeline. ")
     inputs: List[PipelineUserProvidedInputDefinition] = Field(description="A list of user-provided input fields and specifications for the Pipeline. ")
-    __properties: ClassVar[List[str]] = ["pipelineName", "displayName", "pipelineVersion", "description", "type", "inputs"]
+    pipeline_quota: PipelineQuota = Field(alias="pipelineQuota")
+    __properties: ClassVar[List[str]] = ["pipelineName", "displayName", "pipelineVersion", "description", "type", "inputs", "pipelineQuota"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -81,6 +83,9 @@ class PipelineWithDetails(BaseModel):
                 if _item_inputs:
                     _items.append(_item_inputs.to_dict())
             _dict['inputs'] = _items
+        # override the default output from pydantic by calling `to_dict()` of pipeline_quota
+        if self.pipeline_quota:
+            _dict['pipelineQuota'] = self.pipeline_quota.to_dict()
         return _dict
 
     @classmethod
@@ -98,7 +103,8 @@ class PipelineWithDetails(BaseModel):
             "pipelineVersion": obj.get("pipelineVersion"),
             "description": obj.get("description"),
             "type": obj.get("type"),
-            "inputs": [PipelineUserProvidedInputDefinition.from_dict(_item) for _item in obj["inputs"]] if obj.get("inputs") is not None else None
+            "inputs": [PipelineUserProvidedInputDefinition.from_dict(_item) for _item in obj["inputs"]] if obj.get("inputs") is not None else None,
+            "pipelineQuota": PipelineQuota.from_dict(obj["pipelineQuota"]) if obj.get("pipelineQuota") is not None else None
         })
         return _obj
 

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/terra_scientific_pipelines_service_api_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: terra-scientific-pipelines-service-api-client
-Version: 1.0.15
+Version: 1.0.17
 Summary: Terra Scientific Pipelines Service
 Home-page: 
 Author: OpenAPI Generator community

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/terra_scientific_pipelines_service_api_client.egg-info/SOURCES.txt

@@ -29,6 +29,7 @@ teaspoons_client/models/job_control.py
 teaspoons_client/models/job_report.py
 teaspoons_client/models/job_result.py
 teaspoons_client/models/pipeline.py
+teaspoons_client/models/pipeline_quota.py
 teaspoons_client/models/pipeline_run.py
 teaspoons_client/models/pipeline_run_report.py
 teaspoons_client/models/pipeline_user_provided_input_definition.py
@@ -61,6 +62,7 @@ test/test_job_report.py
 test/test_job_result.py
 test/test_jobs_api.py
 test/test_pipeline.py
+test/test_pipeline_quota.py
 test/test_pipeline_run.py
 test/test_pipeline_run_report.py
 test/test_pipeline_runs_api.py

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/test/test_get_pipeline_runs_response.py

@@ -41,6 +41,7 @@ class TestGetPipelineRunsResponse(unittest.TestCase):
                     teaspoons_client.models.pipeline_run.PipelineRun(
                         job_id = '', 
                         pipeline_name = '', 
+                        pipeline_version = 56, 
                         status = '', 
                         description = '', 
                         time_submitted = '', 

terra_scientific_pipelines_service_api_client-1.0.17/test/test_pipeline_quota.py

@@ -0,0 +1,58 @@
+# coding: utf-8
+
+"""
+    Terra Scientific Pipelines Service
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from teaspoons_client.models.pipeline_quota import PipelineQuota
+
+class TestPipelineQuota(unittest.TestCase):
+    """PipelineQuota unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> PipelineQuota:
+        """Test PipelineQuota
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `PipelineQuota`
+        """
+        model = PipelineQuota()
+        if include_optional:
+            return PipelineQuota(
+                pipeline_name = '',
+                default_quota = 56,
+                min_quota_consumed = 56,
+                quota_units = ''
+            )
+        else:
+            return PipelineQuota(
+                pipeline_name = '',
+                default_quota = 56,
+                min_quota_consumed = 56,
+                quota_units = '',
+        )
+        """
+
+    def testPipelineQuota(self):
+        """Test PipelineQuota"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/test/test_pipeline_run.py

@@ -37,6 +37,7 @@ class TestPipelineRun(unittest.TestCase):
             return PipelineRun(
                 job_id = '',
                 pipeline_name = '',
+                pipeline_version = 56,
                 status = '',
                 description = '',
                 time_submitted = '',

{terra_scientific_pipelines_service_api_client-1.0.15 → terra_scientific_pipelines_service_api_client-1.0.17}/test/test_pipeline_with_details.py

@@ -46,7 +46,12 @@ class TestPipelineWithDetails(unittest.TestCase):
                         type = '', 
                         is_required = True, 
                         file_suffix = '', )
-                    ]
+                    ],
+                pipeline_quota = teaspoons_client.models.pipeline_quota.PipelineQuota(
+                    pipeline_name = '', 
+                    default_quota = 56, 
+                    min_quota_consumed = 56, 
+                    quota_units = '', )
             )
         else:
             return PipelineWithDetails(
@@ -62,6 +67,11 @@ class TestPipelineWithDetails(unittest.TestCase):
                         is_required = True, 
                         file_suffix = '', )
                     ],
+                pipeline_quota = teaspoons_client.models.pipeline_quota.PipelineQuota(
+                    pipeline_name = '', 
+                    default_quota = 56, 
+                    min_quota_consumed = 56, 
+                    quota_units = '', ),
         )
         """