terra-scientific-pipelines-service-api-client 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

teaspoons_client/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "0.1.3"
+__version__ = "0.1.5"
 
 # import apis into sdk package
 from teaspoons_client.api.admin_api import AdminApi
@@ -22,6 +22,7 @@ from teaspoons_client.api.jobs_api import JobsApi
 from teaspoons_client.api.pipeline_runs_api import PipelineRunsApi
 from teaspoons_client.api.pipelines_api import PipelinesApi
 from teaspoons_client.api.public_api import PublicApi
+from teaspoons_client.api.quotas_api import QuotasApi
 
 # import ApiClient
 from teaspoons_client.api_response import ApiResponse
@@ -51,6 +52,7 @@ from teaspoons_client.models.pipeline_user_provided_input_definition import Pipe
 from teaspoons_client.models.pipeline_with_details import PipelineWithDetails
 from teaspoons_client.models.prepare_pipeline_run_request_body import PreparePipelineRunRequestBody
 from teaspoons_client.models.prepare_pipeline_run_response import PreparePipelineRunResponse
+from teaspoons_client.models.quota_with_details import QuotaWithDetails
 from teaspoons_client.models.start_pipeline_run_request_body import StartPipelineRunRequestBody
 from teaspoons_client.models.system_status import SystemStatus
 from teaspoons_client.models.system_status_systems_value import SystemStatusSystemsValue

teaspoons_client/api/__init__.py

@@ -6,4 +6,5 @@ from teaspoons_client.api.jobs_api import JobsApi
 from teaspoons_client.api.pipeline_runs_api import PipelineRunsApi
 from teaspoons_client.api.pipelines_api import PipelinesApi
 from teaspoons_client.api.public_api import PublicApi
+from teaspoons_client.api.quotas_api import QuotasApi
 

teaspoons_client/api/quotas_api.py

@@ -0,0 +1,303 @@
+# 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 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 teaspoons_client.models.quota_with_details import QuotaWithDetails
+
+from teaspoons_client.api_client import ApiClient, RequestSerialized
+from teaspoons_client.api_response import ApiResponse
+from teaspoons_client.rest import RESTResponseType
+
+
+class QuotasApi:
+    """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 get_quota_for_pipeline(
+        self,
+        pipeline_name: Annotated[StrictStr, Field(description="A string identifier to used to identify a pipeline in the service.")],
+        _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,
+    ) -> QuotaWithDetails:
+        """Return info about the user's quota usage for the specified pipeline
+
+
+        :param pipeline_name: A string identifier to used to identify a pipeline in the service. (required)
+        :type pipeline_name: str
+        :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._get_quota_for_pipeline_serialize(
+            pipeline_name=pipeline_name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "QuotaWithDetails",
+            '400': "ErrorReport",
+            '500': "ErrorReport",
+        }
+        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 get_quota_for_pipeline_with_http_info(
+        self,
+        pipeline_name: Annotated[StrictStr, Field(description="A string identifier to used to identify a pipeline in the service.")],
+        _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[QuotaWithDetails]:
+        """Return info about the user's quota usage for the specified pipeline
+
+
+        :param pipeline_name: A string identifier to used to identify a pipeline in the service. (required)
+        :type pipeline_name: str
+        :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._get_quota_for_pipeline_serialize(
+            pipeline_name=pipeline_name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "QuotaWithDetails",
+            '400': "ErrorReport",
+            '500': "ErrorReport",
+        }
+        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 get_quota_for_pipeline_without_preload_content(
+        self,
+        pipeline_name: Annotated[StrictStr, Field(description="A string identifier to used to identify a pipeline in the service.")],
+        _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:
+        """Return info about the user's quota usage for the specified pipeline
+
+
+        :param pipeline_name: A string identifier to used to identify a pipeline in the service. (required)
+        :type pipeline_name: str
+        :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._get_quota_for_pipeline_serialize(
+            pipeline_name=pipeline_name,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "QuotaWithDetails",
+            '400': "ErrorReport",
+            '500': "ErrorReport",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_quota_for_pipeline_serialize(
+        self,
+        pipeline_name,
+        _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 pipeline_name is not None:
+            _path_params['pipelineName'] = pipeline_name
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'oidc', 
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/api/quotas/v1/{pipelineName}',
+            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
+        )
+
+

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/0.1.3/python'
+        self.user_agent = 'terra-scientific-pipelines-service-api-client/0.1.5/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: 0.1.3".\
+               "SDK Package Version: 0.1.5".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

teaspoons_client/models/__init__.py

@@ -30,6 +30,7 @@ from teaspoons_client.models.pipeline_user_provided_input_definition import Pipe
 from teaspoons_client.models.pipeline_with_details import PipelineWithDetails
 from teaspoons_client.models.prepare_pipeline_run_request_body import PreparePipelineRunRequestBody
 from teaspoons_client.models.prepare_pipeline_run_response import PreparePipelineRunResponse
+from teaspoons_client.models.quota_with_details import QuotaWithDetails
 from teaspoons_client.models.start_pipeline_run_request_body import StartPipelineRunRequestBody
 from teaspoons_client.models.system_status import SystemStatus
 from teaspoons_client.models.system_status_systems_value import SystemStatusSystemsValue

teaspoons_client/models/quota_with_details.py

@@ -0,0 +1,91 @@
+# 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 QuotaWithDetails(BaseModel):
+    """
+    Object containing the pipeline identifier, quota limit, and quota usage of a Pipeline. 
+    """ # 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")
+    __properties: ClassVar[List[str]] = ["pipelineName", "quotaLimit", "quotaConsumed"]
+
+    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 QuotaWithDetails 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 QuotaWithDetails 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"),
+            "quotaLimit": obj.get("quotaLimit"),
+            "quotaConsumed": obj.get("quotaConsumed")
+        })
+        return _obj
+
+

{terra_scientific_pipelines_service_api_client-0.1.3.dist-info → terra_scientific_pipelines_service_api_client-0.1.5.dist-info}/METADATA

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

{terra_scientific_pipelines_service_api_client-0.1.3.dist-info → terra_scientific_pipelines_service_api_client-0.1.5.dist-info}/RECORD

@@ -1,17 +1,18 @@
-teaspoons_client/__init__.py,sha256=2v_w-P5KVYD1LVzB9oYq5jcUDAy71BJPpM-0e_vIes4,2845
-teaspoons_client/api_client.py,sha256=BzeLTESVZfe9OWIzxf3-863kUdxMq7R7CwevPmKZ7T0,27534
+teaspoons_client/__init__.py,sha256=V1GvWedo7u-iH2YCSEAmnyVF6AXO1BgqLt7YOpYbyz8,2971
+teaspoons_client/api_client.py,sha256=S1mxLhXLSoqOsedU7MVGraPOK-pXEnaAeNrL49oOvdo,27534
 teaspoons_client/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
-teaspoons_client/configuration.py,sha256=3JaZmMell-p2mLAxpbXUhFa3KgDBEtEqweNHeBu0xW8,15584
+teaspoons_client/configuration.py,sha256=UrdF5IKuK7DvBMzUP5pcLc08hL4kCZ7JoaD1rVvHlyw,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
-teaspoons_client/api/__init__.py,sha256=HtNBJMapZXvdi3mVrWN6NS_O2zyfTAdG9JT6PPXgsuo,331
+teaspoons_client/api/__init__.py,sha256=j4nfxEv5WV8rGkUs8vl0-ZGilqzKUPZfFV_FGq0cg_c,385
 teaspoons_client/api/admin_api.py,sha256=ZQY_kbDZolLp34J0j1JJ1cy2yC5PPYML6y3vhGW6ka8,23925
 teaspoons_client/api/jobs_api.py,sha256=erVrdxvQubuUpvqIyAqAlD0nYc-TQlxH5ZhE9_lH6iE,22994
 teaspoons_client/api/pipeline_runs_api.py,sha256=pkYlLSCfma6TQsLGPOFBUJj65UbS3YZIEfim5Z8Kgdk,49631
 teaspoons_client/api/pipelines_api.py,sha256=kTqVQ9kf816Qyns4ocquXIH-b0C_MK-6dx0HOMsXHpk,21192
 teaspoons_client/api/public_api.py,sha256=cYrfhy7epadJPWvXO7xvjhyNRH72bKVXtUmjefezbl0,19743
-teaspoons_client/models/__init__.py,sha256=InrLWQbY3PM14TWE9wtAqHpyV_uCRkq8zFtqNZuMjEk,2000
+teaspoons_client/api/quotas_api.py,sha256=fU2ZE0B-5ELvkNdXHTWCw0asfLDNK4WetlKVvpWETmI,11862
+teaspoons_client/models/__init__.py,sha256=kUQAgMQB8FtJvjlKUZo_kDWk6xo83hXj32N2jPhW9O0,2072
 teaspoons_client/models/admin_pipeline.py,sha256=3Ci4-PVXjqO3bgRLrTdRsfEVEsXSS5XDtARQdMOGJnI,4349
 teaspoons_client/models/async_pipeline_run_response.py,sha256=c_Nj3tC41y2G0pqvVwzKn_bVE6mgA2h_Aisp6315zSE,3899
 teaspoons_client/models/error_report.py,sha256=3IsEF07EPxdcMSPCMW4yE1pXydE8EHmlIBYVScvXyXs,2714
@@ -28,12 +29,13 @@ teaspoons_client/models/pipeline_user_provided_input_definition.py,sha256=jEC7yU
 teaspoons_client/models/pipeline_with_details.py,sha256=c489n3m6bswOGKGnVLupcB-KCAVgQdihUnNKov9LSmA,3929
 teaspoons_client/models/prepare_pipeline_run_request_body.py,sha256=UhsnYEuFFX8dQ2BryxH-A0zgchwBCz69JDJPvaxQOig,3147
 teaspoons_client/models/prepare_pipeline_run_response.py,sha256=5Y-NTPjxR13brTHbCWU-1YBXERUWRsg7ShNRK1bcyJM,2948
+teaspoons_client/models/quota_with_details.py,sha256=9f7y_SL5NQ17Jbi9PFAAMphXEc718AjQE1O3P8dRsq0,3066
 teaspoons_client/models/start_pipeline_run_request_body.py,sha256=Et4zcC9UVnINscI4OVtmHlhe1MvPgMq0819sNqyLLOw,3167
 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=OYjf_6SVBg00GjGzq9aftbeLJkUHikm80sqFQQSWvUQ,3257
 teaspoons_client/models/version_properties.py,sha256=pnx1pduz4vnw-wx_sdASU_-zRqE1wf3JdNm4OLDJ2i8,2888
-terra_scientific_pipelines_service_api_client-0.1.3.dist-info/METADATA,sha256=F1vidjs8F-VQWC7_CHQwf3FMicWdIYST7ixJ9ECywxA,592
-terra_scientific_pipelines_service_api_client-0.1.3.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
-terra_scientific_pipelines_service_api_client-0.1.3.dist-info/top_level.txt,sha256=DZYs7jBZ-_bWvnXrtK1TbtfhltgkuPWTRo1Ei7Uv9Jc,17
-terra_scientific_pipelines_service_api_client-0.1.3.dist-info/RECORD,,
+terra_scientific_pipelines_service_api_client-0.1.5.dist-info/METADATA,sha256=7gCYzuPbjWnrsoK87ixFanDQ-TuiZoMMZvpiPQzkmjc,592
+terra_scientific_pipelines_service_api_client-0.1.5.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+terra_scientific_pipelines_service_api_client-0.1.5.dist-info/top_level.txt,sha256=DZYs7jBZ-_bWvnXrtK1TbtfhltgkuPWTRo1Ei7Uv9Jc,17
+terra_scientific_pipelines_service_api_client-0.1.5.dist-info/RECORD,,