terra-scientific-pipelines-service-api-client 1.2.0__py3-none-any.whl → 1.2.2__py3-none-any.whl

teaspoons_client/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.2.0"
+__version__ = "1.2.2"
 
 # import apis into sdk package
 from teaspoons_client.api.admin_api import AdminApi
@@ -49,6 +49,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_output_definition import PipelineOutputDefinition
 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

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.2.0/python'
+        self.user_agent = 'terra-scientific-pipelines-service-api-client/1.2.2/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

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.2.0".\
+               "SDK Package Version: 1.2.2".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

teaspoons_client/models/__init__.py

@@ -27,6 +27,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_output_definition import PipelineOutputDefinition
 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

teaspoons_client/models/admin_quota.py

@@ -29,7 +29,7 @@ class AdminQuota(BaseModel):
     user_id: StrictStr = Field(description="The identifier string for the user who submitted a job request. ", alias="userId")
     pipeline_name: StrictStr = Field(description="The identifier string for the Pipeline. ", alias="pipelineName")
     quota_limit: StrictInt = Field(description="Maximum allowable quota for the pipeline ", alias="quotaLimit")
-    quota_consumed: StrictInt = Field(description="Quota consumed by the user ", alias="quotaConsumed")
+    quota_consumed: StrictInt = Field(description="Quota consumed by the user or job ", alias="quotaConsumed")
     __properties: ClassVar[List[str]] = ["userId", "pipelineName", "quotaLimit", "quotaConsumed"]
 
     model_config = ConfigDict(

teaspoons_client/models/pipeline_output_definition.py

@@ -0,0 +1,89 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PipelineOutputDefinition(BaseModel):
+    """
+    An output field and its specifications for the Pipeline. 
+    """ # noqa: E501
+    name: Optional[StrictStr] = Field(default=None, description="The name of the output field. ")
+    type: Optional[StrictStr] = Field(default=None, description="The type of the output field. ")
+    __properties: ClassVar[List[str]] = ["name", "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 PipelineOutputDefinition 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 PipelineOutputDefinition from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "type": obj.get("type")
+        })
+        return _obj
+
+

teaspoons_client/models/pipeline_run.py

@@ -33,7 +33,7 @@ class PipelineRun(BaseModel):
     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")
+    quota_consumed: Optional[StrictInt] = Field(default=None, description="Quota consumed by the user or job ", alias="quotaConsumed")
     __properties: ClassVar[List[str]] = ["jobId", "pipelineName", "pipelineVersion", "status", "description", "timeSubmitted", "timeCompleted", "quotaConsumed"]
 
     model_config = ConfigDict(

teaspoons_client/models/pipeline_run_report.py

@@ -31,7 +31,8 @@ class PipelineRunReport(BaseModel):
     tool_version: StrictStr = Field(description="An identifier string for the Pipeline Tool Version i.e. github repo tag/branch/release ", alias="toolVersion")
     outputs: Optional[Dict[str, Any]] = Field(default=None, description="The output(s) of a successful pipeline run. ")
     output_expiration_date: Optional[StrictStr] = Field(default=None, description="The Date when the pipeline outputs will expire. ", alias="outputExpirationDate")
-    __properties: ClassVar[List[str]] = ["pipelineName", "pipelineVersion", "toolVersion", "outputs", "outputExpirationDate"]
+    quota_consumed: Optional[StrictInt] = Field(default=None, description="Quota consumed by the user or job ", alias="quotaConsumed")
+    __properties: ClassVar[List[str]] = ["pipelineName", "pipelineVersion", "toolVersion", "outputs", "outputExpirationDate", "quotaConsumed"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -88,7 +89,8 @@ class PipelineRunReport(BaseModel):
             "pipelineVersion": obj.get("pipelineVersion"),
             "toolVersion": obj.get("toolVersion"),
             "outputs": obj.get("outputs"),
-            "outputExpirationDate": obj.get("outputExpirationDate")
+            "outputExpirationDate": obj.get("outputExpirationDate"),
+            "quotaConsumed": obj.get("quotaConsumed")
         })
         return _obj
 

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_output_definition import PipelineOutputDefinition
 from teaspoons_client.models.pipeline_quota import PipelineQuota
 from teaspoons_client.models.pipeline_user_provided_input_definition import PipelineUserProvidedInputDefinition
 from typing import Optional, Set
@@ -34,8 +35,9 @@ 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. ")
+    outputs: List[PipelineOutputDefinition] = Field(description="A list of output fields and specifications for the Pipeline. ")
     pipeline_quota: PipelineQuota = Field(alias="pipelineQuota")
-    __properties: ClassVar[List[str]] = ["pipelineName", "displayName", "pipelineVersion", "description", "type", "inputs", "pipelineQuota"]
+    __properties: ClassVar[List[str]] = ["pipelineName", "displayName", "pipelineVersion", "description", "type", "inputs", "outputs", "pipelineQuota"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -83,6 +85,13 @@ 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 each item in outputs (list)
+        _items = []
+        if self.outputs:
+            for _item_outputs in self.outputs:
+                if _item_outputs:
+                    _items.append(_item_outputs.to_dict())
+            _dict['outputs'] = _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()
@@ -104,6 +113,7 @@ class PipelineWithDetails(BaseModel):
             "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,
+            "outputs": [PipelineOutputDefinition.from_dict(_item) for _item in obj["outputs"]] if obj.get("outputs") is not None else None,
             "pipelineQuota": PipelineQuota.from_dict(obj["pipelineQuota"]) if obj.get("pipelineQuota") is not None else None
         })
         return _obj

teaspoons_client/models/quota_with_details.py

@@ -28,7 +28,7 @@ class QuotaWithDetails(BaseModel):
     """ # noqa: E501
     pipeline_name: StrictStr = Field(description="The identifier string for the Pipeline. ", alias="pipelineName")
     quota_limit: StrictInt = Field(description="Maximum allowable quota for the pipeline ", alias="quotaLimit")
-    quota_consumed: StrictInt = Field(description="Quota consumed by the user ", alias="quotaConsumed")
+    quota_consumed: StrictInt = Field(description="Quota consumed by the user or job ", alias="quotaConsumed")
     quota_units: StrictStr = Field(description="Units for pipeline quota ", alias="quotaUnits")
     __properties: ClassVar[List[str]] = ["pipelineName", "quotaLimit", "quotaConsumed", "quotaUnits"]
 

{terra_scientific_pipelines_service_api_client-1.2.0.dist-info → terra_scientific_pipelines_service_api_client-1.2.2.dist-info}/METADATA

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

{terra_scientific_pipelines_service_api_client-1.2.0.dist-info → terra_scientific_pipelines_service_api_client-1.2.2.dist-info}/RECORD

@@ -1,7 +1,7 @@
-teaspoons_client/__init__.py,sha256=WV54-PTVZMvpN51IiCtpFdQptGuCWKz5OpBLnxOQjJE,3383
-teaspoons_client/api_client.py,sha256=A5fSqAgZ4veJg5mixoACRu5w-DI-2nWVr_Wgk2oU1b4,27534
+teaspoons_client/__init__.py,sha256=kz1yGWoF3r35YK8jOZwYG45T6G8huiRviZtxDP9MTmk,3471
+teaspoons_client/api_client.py,sha256=gRzN-iGY4bowdgAcXAL8fnBMrnFY5t4IApEOotAFgP0,27534
 teaspoons_client/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
-teaspoons_client/configuration.py,sha256=Wbv8b_5LMn16qSJ5T6pMfV8oB329Y4L2krFXY7zTX4Y,15584
+teaspoons_client/configuration.py,sha256=CuV-JTjbvsPQxhIvexu_m4mb0x32Yif1os3iPivuNOo,15584
 teaspoons_client/exceptions.py,sha256=54himL4zduna12UfdUqGb8LEVunPChzEvjvPw0DjWjk,5999
 teaspoons_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 teaspoons_client/rest.py,sha256=wRFTSvE7v-UjFP1_9oozGWnt8ERYW-PReLkFJZHiWYI,9441
@@ -12,9 +12,9 @@ teaspoons_client/api/pipeline_runs_api.py,sha256=zp0Nuh_XHCzR54DoV-egeg7Jah2Ydb2
 teaspoons_client/api/pipelines_api.py,sha256=9PZ_qSMnZK4bbO-oCxLub73KJ7kLxanjkMtjXMjUOGA,22868
 teaspoons_client/api/public_api.py,sha256=cYrfhy7epadJPWvXO7xvjhyNRH72bKVXtUmjefezbl0,19743
 teaspoons_client/api/quotas_api.py,sha256=fU2ZE0B-5ELvkNdXHTWCw0asfLDNK4WetlKVvpWETmI,11862
-teaspoons_client/models/__init__.py,sha256=DkvDIv3RjlhAoeREtdhGwo1P7uWw2fD32nE0cJ_2RzI,2484
+teaspoons_client/models/__init__.py,sha256=RKny69fz47PKhUgVGaM5aNq20LIuMw5MXDeHQMe-AZ8,2572
 teaspoons_client/models/admin_pipeline.py,sha256=mBrSi3XCGifa2ZF02SdSzoCjfsqoXerimwlqkC6yHAc,4551
-teaspoons_client/models/admin_quota.py,sha256=X0Pll_9JWs1VmmElic8m7-pN6PCIRnxc1nyYyWjlK0w,3245
+teaspoons_client/models/admin_quota.py,sha256=havkt2BGtU9zr1mSAiFidyCGjtVbJC4Jr2_f9e3vWWw,3252
 teaspoons_client/models/async_pipeline_run_response.py,sha256=c_Nj3tC41y2G0pqvVwzKn_bVE6mgA2h_Aisp6315zSE,3899
 teaspoons_client/models/error_report.py,sha256=3IsEF07EPxdcMSPCMW4yE1pXydE8EHmlIBYVScvXyXs,2714
 teaspoons_client/models/get_jobs_response.py,sha256=Vdz0yG4q4TjbkLuyI13xaabR6Qn_nF3LNxn04qjRPl8,3388
@@ -26,21 +26,22 @@ teaspoons_client/models/job_control.py,sha256=PkTmAKmm6JXxu7EUfa02UNdBaxoZvo0v0T
 teaspoons_client/models/job_report.py,sha256=q5ijrPgVmGqXjrTZKzEyOswUlWKsMD6v-oTFDUUdMRg,3974
 teaspoons_client/models/job_result.py,sha256=WWZRoqmTuh5ZP9ugMENGZUx5zrzADHx9O0m2Bhh--yg,3337
 teaspoons_client/models/pipeline.py,sha256=KiEoZb6w9MMTAr1-Scr70XBNDr7eox69g9ZLa8ORRLE,3224
+teaspoons_client/models/pipeline_output_definition.py,sha256=i4_C-twohgay8xqwN6IgjwF6MqqInnosH-9MPcKwxx0,2810
 teaspoons_client/models/pipeline_quota.py,sha256=jKXNhWM5gNKMwqOxAkQ0skpKSL2Jb1Ou8xNwtAlPWS0,3183
-teaspoons_client/models/pipeline_run.py,sha256=KWfU6xljqiDzGF7IBBFd0dUGy3esAzOqvIjg1CG1Ax4,4064
-teaspoons_client/models/pipeline_run_report.py,sha256=ul4o41vBFVLAiLyHxaToqnsVdXQRo16wEY8V5rjaMP8,3636
+teaspoons_client/models/pipeline_run.py,sha256=C5T1E90oTNeGFJcllQSsqQnhceNsPf-wdZgZ0TWADE0,4071
+teaspoons_client/models/pipeline_run_report.py,sha256=U_iDIRq-BjhYNqWmRztcWyozuJLtVoWrdBlU_T8mbug,3843
 teaspoons_client/models/pipeline_user_provided_input_definition.py,sha256=b1W1Ja9PnaEjZHV3MoW1ylisPqnSwFO9bVXrkySOzqQ,3252
-teaspoons_client/models/pipeline_with_details.py,sha256=IpAUDmJtHIUffJhC61SPvcPPKuEFP7u4DhvCNY0ci7A,4612
+teaspoons_client/models/pipeline_with_details.py,sha256=yObiGAV_vIp6rvMZ1pPK-ieaxDkWfI_mVsuzWn-4lAc,5309
 teaspoons_client/models/prepare_pipeline_run_request_body.py,sha256=mW6L2AWwt-h4MRd7sMoo1GmePf19JRIFpO6ltDO_548,3897
 teaspoons_client/models/prepare_pipeline_run_response.py,sha256=1lSm1DAgTfPlBIEXkhnciAgMBY0eC3sjlEEJOY7MtyA,2890
-teaspoons_client/models/quota_with_details.py,sha256=wO1xczv8PxCIEs_1r9Uz5BuVdm1nld1SfvpIJNB2how,3225
+teaspoons_client/models/quota_with_details.py,sha256=04dsaUX3U04nme7loG3EwJHLD0BJmCcMXTpPcOnb5tQ,3232
 teaspoons_client/models/start_pipeline_run_request_body.py,sha256=l5UJEXac-WLXDi4tAgMJpFZcIIWuhsKuKHQc0ihheGE,2959
 teaspoons_client/models/system_status.py,sha256=615Ol6vBFowfewWesLeQe6aljaKMXIZb1rgWxt5FNsg,3305
 teaspoons_client/models/system_status_systems_value.py,sha256=lKuq0aDpRne858ta4gvSZL7JMqc7V3TJcVUmj9-OgOo,2675
 teaspoons_client/models/update_pipeline_request_body.py,sha256=DJeqxOAwDQdQDApDQdGbASbDtsb2hqRSfuV1F7yrL6o,3232
 teaspoons_client/models/update_quota_limit_request_body.py,sha256=sOCNcTbsdTJisAn9YxHMIWUvm_UrxV1HZ5EziIUOgIk,2731
 teaspoons_client/models/version_properties.py,sha256=pnx1pduz4vnw-wx_sdASU_-zRqE1wf3JdNm4OLDJ2i8,2888
-terra_scientific_pipelines_service_api_client-1.2.0.dist-info/METADATA,sha256=SZqDcd8e1uwpXLarIx0YwW2COPa00xrueJaJu30YSMI,739
-terra_scientific_pipelines_service_api_client-1.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-terra_scientific_pipelines_service_api_client-1.2.0.dist-info/top_level.txt,sha256=DZYs7jBZ-_bWvnXrtK1TbtfhltgkuPWTRo1Ei7Uv9Jc,17
-terra_scientific_pipelines_service_api_client-1.2.0.dist-info/RECORD,,
+terra_scientific_pipelines_service_api_client-1.2.2.dist-info/METADATA,sha256=YBxhNMqaiJVdO19BI3DNIkyZl5hlzNg9uE-AwURTmVw,739
+terra_scientific_pipelines_service_api_client-1.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+terra_scientific_pipelines_service_api_client-1.2.2.dist-info/top_level.txt,sha256=DZYs7jBZ-_bWvnXrtK1TbtfhltgkuPWTRo1Ei7Uv9Jc,17
+terra_scientific_pipelines_service_api_client-1.2.2.dist-info/RECORD,,