step_rest_client 1.0.0__py3-none-any.whl

step_rest_client/models/workflow_task_query.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+
+"""
+    STEP REST API V2
+
+    <h1>About</h1><p>The STEP REST API V2 provides read and write access to a set of core STEP objects using the HTTP operations GET, PUT, POST, PATCH and DELETE.</p><h1>Resource Representation</h1><p>With the exception of a few resource operations for retrieving and uploading binary data, all request and response bodies are JSON, compliant with the schema documented here.</p><h1>Context and Workspace</h1><p>All requests are handled in a specific STEP context and workspace and both can be specified via query parameters available for all resource operations. A context must always be specified while requests per default will be handled in the &quot;Main&quot; workspace.</p><h1>Polymorphism</h1><p>In STEP, attributes, reference types and data container types can all be either single- or multivalued. The STEP REST API V2 uses polymorphism to address this complexity with resources that include values, references and data containers specified to produce and consume a common &quot;abstract&quot; supertype that always will be one of either the single- or multivalued subtype.<br/>As an example, the GET /entities/{id}/values/{attributeId} resource operation is specified to return a &quot;Value&quot; but as evident from the model, the &quot;Value&quot; will always be &quot;oneOf&quot; either &quot;SingleValue&quot;, that has a &quot;value&quot; property for which the value is an object, or &quot;MultiValue&quot;, that has a &quot;values&quot; property for which the value is an array.<br/>Clients are advised to use the presence or absence of the plural array property (&quot;values&quot;, &quot;references&quot; and &quot;dataContainers&quot;) to determine the concrete type.</p><h1>Authentication</h1><p>The REST API is protected by HTTP Basic Authentication or if OAuth2-based authentication is enabled (SaaS customers only), by Bearer Authentication. With Basic Authentication, user name and password are supplied with each request and it is therefore highly recommended to only use the API in conjunction with HTTPS. For more information about OAuth2-based authentication for SaaS customers, please see the STEP Authentication Guide.</p><h1>Versioning</h1><p>The STEP REST API V2 is versioned using semantic versioning. Stibo Systems reserve the right to make non-breaking, minor / patch changes in any release without warning and clients must be coded / configured to be 'tolerant' and capable of handling such changes.</p><p>Examples of breaking, major changes:</p><ul><li>Renaming of a property</li><li>Removal of a property</li><li>Property type change</li><li>Addition of new property required for write operations</li><li>Marking existing property as required for write operations</li><li>Removal of resource or resource operation</li><li>Materially different behavior for existing resource operation</li></ul><p>Examples of non-breaking, minor / patch changes:</p><ul><li>Addition of new properties in request responses</li><li>Addition of new query parameter not required for write operations</li><li>Addition of new resource or resource operation</li><li>Bug fixes that do not change the schema or resource operations as described here</li><li>Inclusion of a response body for resource operations specified to return a 200 response with no body</li><li>Change of response &quot;Model&quot; / &quot;schema&quot; to type extending the previously specified type</li><li>Renaming a &quot;Model&quot; / &quot;schema&quot; type</li></ul><p>In addition, error message texts may change without warning within the same version. Client program logic should not depend upon the message content.</p><h1>Error Handling</h1><p>The STEP REST API V2 responds with standard HTTP status codes, with 2** responses indicating a success, 4** responses indicating a client error and 5** indicating a server error. Notice that this specification does not specify common error responses like 500 (internal server error) or 401 (unauthorized) for the individual resource operations. Clients should however be capable of handling such responses.</p><p>Error responses have a JSON response body (see Error schema below) containing HTTP status code information in addition to a message providing details about the error. As mentioned above, client program logic should not depend upon the message content.</p><p>The specific status codes used in the API are:</p><ul><li>200 (OK): Success, response may or may not have a body</li><li>201 (Created): Entity successfully created, response may or may not have a body</li><li>400 (Bad request): The server cannot or will not process the request due to an apparent client error</li><li>401 (Unauthorized): Returned only in relation to failed authentication</li><li>404 (Not Found): Returned only in relation to objects specified via path parameters (variable parts of the URL). If STEP objects referenced in request bodies or via query parameters cannot be found, the response will be 400.</li><li>429 (Too Many Requests): Clients are per default limited to 100 requests per second. Returned if the rate limit is exceeded.</li><li>500 (Internal Server Error): Unexpected error (could potentially cover an issue that rightfully should be a 400)</li></ul>
+
+    The version of the OpenAPI document: 1.3.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from step_rest_client.models.workflow_node import WorkflowNode
+from typing import Optional, Set
+from typing_extensions import Self
+
+class WorkflowTaskQuery(BaseModel):
+    """
+    A workflow task query specification. All properties are optional query filters. If no values are supplied, the query will match all tasks assigned to the user executing the query and tasks assigned to groups that the user is a member of.
+    """ # noqa: E501
+    node: Optional[WorkflowNode] = None
+    workflow: Optional[StrictStr] = Field(default=None, description="Optional workflow filter. Can be populated with workflow ID.")
+    state: Optional[StrictStr] = Field(default=None, description="Optional state filter. Can be populated with state ID.")
+    status_flag: Optional[StrictStr] = Field(default=None, description="Optional status flag filter. Can be populated with status flag ID.", alias="statusFlag")
+    direct_assignment: Optional[StrictBool] = Field(default=False, description="If 'true', the query will match only tasks assigned directly to the user invoking the operation. If 'false', the query will match both tasks assigned directly to the user and tasks assigned to a group that the user is a member of.", alias="directAssignment")
+    include_non_leaf_tasks: Optional[StrictBool] = Field(default=False, description="If 'true', the query will match tasks for 'parallels' and 'clusters' in addition to 'leaf tasks'", alias="includeNonLeafTasks")
+    __properties: ClassVar[List[str]] = ["node", "workflow", "state", "statusFlag", "directAssignment", "includeNonLeafTasks"]
+
+    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 WorkflowTaskQuery 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 node
+        if self.node:
+            _dict['node'] = self.node.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WorkflowTaskQuery from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "node": WorkflowNode.from_dict(obj["node"]) if obj.get("node") is not None else None,
+            "workflow": obj.get("workflow"),
+            "state": obj.get("state"),
+            "statusFlag": obj.get("statusFlag"),
+            "directAssignment": obj.get("directAssignment") if obj.get("directAssignment") is not None else False,
+            "includeNonLeafTasks": obj.get("includeNonLeafTasks") if obj.get("includeNonLeafTasks") is not None else False
+        })
+        return _obj
+
+

step_rest_client/rest.py

@@ -0,0 +1,258 @@
+# coding: utf-8
+
+"""
+    STEP REST API V2
+
+    <h1>About</h1><p>The STEP REST API V2 provides read and write access to a set of core STEP objects using the HTTP operations GET, PUT, POST, PATCH and DELETE.</p><h1>Resource Representation</h1><p>With the exception of a few resource operations for retrieving and uploading binary data, all request and response bodies are JSON, compliant with the schema documented here.</p><h1>Context and Workspace</h1><p>All requests are handled in a specific STEP context and workspace and both can be specified via query parameters available for all resource operations. A context must always be specified while requests per default will be handled in the &quot;Main&quot; workspace.</p><h1>Polymorphism</h1><p>In STEP, attributes, reference types and data container types can all be either single- or multivalued. The STEP REST API V2 uses polymorphism to address this complexity with resources that include values, references and data containers specified to produce and consume a common &quot;abstract&quot; supertype that always will be one of either the single- or multivalued subtype.<br/>As an example, the GET /entities/{id}/values/{attributeId} resource operation is specified to return a &quot;Value&quot; but as evident from the model, the &quot;Value&quot; will always be &quot;oneOf&quot; either &quot;SingleValue&quot;, that has a &quot;value&quot; property for which the value is an object, or &quot;MultiValue&quot;, that has a &quot;values&quot; property for which the value is an array.<br/>Clients are advised to use the presence or absence of the plural array property (&quot;values&quot;, &quot;references&quot; and &quot;dataContainers&quot;) to determine the concrete type.</p><h1>Authentication</h1><p>The REST API is protected by HTTP Basic Authentication or if OAuth2-based authentication is enabled (SaaS customers only), by Bearer Authentication. With Basic Authentication, user name and password are supplied with each request and it is therefore highly recommended to only use the API in conjunction with HTTPS. For more information about OAuth2-based authentication for SaaS customers, please see the STEP Authentication Guide.</p><h1>Versioning</h1><p>The STEP REST API V2 is versioned using semantic versioning. Stibo Systems reserve the right to make non-breaking, minor / patch changes in any release without warning and clients must be coded / configured to be 'tolerant' and capable of handling such changes.</p><p>Examples of breaking, major changes:</p><ul><li>Renaming of a property</li><li>Removal of a property</li><li>Property type change</li><li>Addition of new property required for write operations</li><li>Marking existing property as required for write operations</li><li>Removal of resource or resource operation</li><li>Materially different behavior for existing resource operation</li></ul><p>Examples of non-breaking, minor / patch changes:</p><ul><li>Addition of new properties in request responses</li><li>Addition of new query parameter not required for write operations</li><li>Addition of new resource or resource operation</li><li>Bug fixes that do not change the schema or resource operations as described here</li><li>Inclusion of a response body for resource operations specified to return a 200 response with no body</li><li>Change of response &quot;Model&quot; / &quot;schema&quot; to type extending the previously specified type</li><li>Renaming a &quot;Model&quot; / &quot;schema&quot; type</li></ul><p>In addition, error message texts may change without warning within the same version. Client program logic should not depend upon the message content.</p><h1>Error Handling</h1><p>The STEP REST API V2 responds with standard HTTP status codes, with 2** responses indicating a success, 4** responses indicating a client error and 5** indicating a server error. Notice that this specification does not specify common error responses like 500 (internal server error) or 401 (unauthorized) for the individual resource operations. Clients should however be capable of handling such responses.</p><p>Error responses have a JSON response body (see Error schema below) containing HTTP status code information in addition to a message providing details about the error. As mentioned above, client program logic should not depend upon the message content.</p><p>The specific status codes used in the API are:</p><ul><li>200 (OK): Success, response may or may not have a body</li><li>201 (Created): Entity successfully created, response may or may not have a body</li><li>400 (Bad request): The server cannot or will not process the request due to an apparent client error</li><li>401 (Unauthorized): Returned only in relation to failed authentication</li><li>404 (Not Found): Returned only in relation to objects specified via path parameters (variable parts of the URL). If STEP objects referenced in request bodies or via query parameters cannot be found, the response will be 400.</li><li>429 (Too Many Requests): Clients are per default limited to 100 requests per second. Returned if the rate limit is exceeded.</li><li>500 (Internal Server Error): Unexpected error (could potentially cover an issue that rightfully should be a 400)</li></ul>
+
+    The version of the OpenAPI document: 1.3.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from step_rest_client.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+            "ca_cert_data": configuration.ca_cert_data,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :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.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

step_rest_client-1.0.0.dist-info/METADATA

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: step-rest-client
+Version: 1.0.0
+Summary: STEP REST API V2
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: team@openapitools.org
+Keywords: OpenAPI,OpenAPI-Generator,STEP REST API V2
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=1.25.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: summary
+
+    &lt;h1&gt;About&lt;/h1&gt;&lt;p&gt;The STEP REST API V2 provides read and write access to a set of core STEP objects using the HTTP operations GET, PUT, POST, PATCH and DELETE.&lt;/p&gt;&lt;h1&gt;Resource Representation&lt;/h1&gt;&lt;p&gt;With the exception of a few resource operations for retrieving and uploading binary data, all request and response bodies are JSON, compliant with the schema documented here.&lt;/p&gt;&lt;h1&gt;Context and Workspace&lt;/h1&gt;&lt;p&gt;All requests are handled in a specific STEP context and workspace and both can be specified via query parameters available for all resource operations. A context must always be specified while requests per default will be handled in the &amp;quot;Main&amp;quot; workspace.&lt;/p&gt;&lt;h1&gt;Polymorphism&lt;/h1&gt;&lt;p&gt;In STEP, attributes, reference types and data container types can all be either single- or multivalued. The STEP REST API V2 uses polymorphism to address this complexity with resources that include values, references and data containers specified to produce and consume a common &amp;quot;abstract&amp;quot; supertype that always will be one of either the single- or multivalued subtype.&lt;br/&gt;As an example, the GET /entities/{id}/values/{attributeId} resource operation is specified to return a &amp;quot;Value&amp;quot; but as evident from the model, the &amp;quot;Value&amp;quot; will always be &amp;quot;oneOf&amp;quot; either &amp;quot;SingleValue&amp;quot;, that has a &amp;quot;value&amp;quot; property for which the value is an object, or &amp;quot;MultiValue&amp;quot;, that has a &amp;quot;values&amp;quot; property for which the value is an array.&lt;br/&gt;Clients are advised to use the presence or absence of the plural array property (&amp;quot;values&amp;quot;, &amp;quot;references&amp;quot; and &amp;quot;dataContainers&amp;quot;) to determine the concrete type.&lt;/p&gt;&lt;h1&gt;Authentication&lt;/h1&gt;&lt;p&gt;The REST API is protected by HTTP Basic Authentication or if OAuth2-based authentication is enabled (SaaS customers only), by Bearer Authentication. With Basic Authentication, user name and password are supplied with each request and it is therefore highly recommended to only use the API in conjunction with HTTPS. For more information about OAuth2-based authentication for SaaS customers, please see the STEP Authentication Guide.&lt;/p&gt;&lt;h1&gt;Versioning&lt;/h1&gt;&lt;p&gt;The STEP REST API V2 is versioned using semantic versioning. Stibo Systems reserve the right to make non-breaking, minor / patch changes in any release without warning and clients must be coded / configured to be &#39;tolerant&#39; and capable of handling such changes.&lt;/p&gt;&lt;p&gt;Examples of breaking, major changes:&lt;/p&gt;&lt;ul&gt;&lt;li&gt;Renaming of a property&lt;/li&gt;&lt;li&gt;Removal of a property&lt;/li&gt;&lt;li&gt;Property type change&lt;/li&gt;&lt;li&gt;Addition of new property required for write operations&lt;/li&gt;&lt;li&gt;Marking existing property as required for write operations&lt;/li&gt;&lt;li&gt;Removal of resource or resource operation&lt;/li&gt;&lt;li&gt;Materially different behavior for existing resource operation&lt;/li&gt;&lt;/ul&gt;&lt;p&gt;Examples of non-breaking, minor / patch changes:&lt;/p&gt;&lt;ul&gt;&lt;li&gt;Addition of new properties in request responses&lt;/li&gt;&lt;li&gt;Addition of new query parameter not required for write operations&lt;/li&gt;&lt;li&gt;Addition of new resource or resource operation&lt;/li&gt;&lt;li&gt;Bug fixes that do not change the schema or resource operations as described here&lt;/li&gt;&lt;li&gt;Inclusion of a response body for resource operations specified to return a 200 response with no body&lt;/li&gt;&lt;li&gt;Change of response &amp;quot;Model&amp;quot; / &amp;quot;schema&amp;quot; to type extending the previously specified type&lt;/li&gt;&lt;li&gt;Renaming a &amp;quot;Model&amp;quot; / &amp;quot;schema&amp;quot; type&lt;/li&gt;&lt;/ul&gt;&lt;p&gt;In addition, error message texts may change without warning within the same version. Client program logic should not depend upon the message content.&lt;/p&gt;&lt;h1&gt;Error Handling&lt;/h1&gt;&lt;p&gt;The STEP REST API V2 responds with standard HTTP status codes, with 2** responses indicating a success, 4** responses indicating a client error and 5** indicating a server error. Notice that this specification does not specify common error responses like 500 (internal server error) or 401 (unauthorized) for the individual resource operations. Clients should however be capable of handling such responses.&lt;/p&gt;&lt;p&gt;Error responses have a JSON response body (see Error schema below) containing HTTP status code information in addition to a message providing details about the error. As mentioned above, client program logic should not depend upon the message content.&lt;/p&gt;&lt;p&gt;The specific status codes used in the API are:&lt;/p&gt;&lt;ul&gt;&lt;li&gt;200 (OK): Success, response may or may not have a body&lt;/li&gt;&lt;li&gt;201 (Created): Entity successfully created, response may or may not have a body&lt;/li&gt;&lt;li&gt;400 (Bad request): The server cannot or will not process the request due to an apparent client error&lt;/li&gt;&lt;li&gt;401 (Unauthorized): Returned only in relation to failed authentication&lt;/li&gt;&lt;li&gt;404 (Not Found): Returned only in relation to objects specified via path parameters (variable parts of the URL). If STEP objects referenced in request bodies or via query parameters cannot be found, the response will be 400.&lt;/li&gt;&lt;li&gt;429 (Too Many Requests): Clients are per default limited to 100 requests per second. Returned if the rate limit is exceeded.&lt;/li&gt;&lt;li&gt;500 (Internal Server Error): Unexpected error (could potentially cover an issue that rightfully should be a 400)&lt;/li&gt;&lt;/ul&gt;
+    

step_rest_client-1.0.0.dist-info/RECORD

@@ -0,0 +1,117 @@
+step_rest_client/__init__.py,sha256=BFLjrrRmnD0kwzBwLTZ--H1w7khd2XNwiEti4jCYUbk,13667
+step_rest_client/api_client.py,sha256=IRqD98Klqk2F3T0-AMvLgu4JlO4gqdqt0w2SG6_xoyg,32581
+step_rest_client/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
+step_rest_client/configuration.py,sha256=jUrlKgq2nAWWEpWzTeGYeTg_5yvSTg9TO4lykcurG20,23730
+step_rest_client/exceptions.py,sha256=Wd5dKUkmD1Xu_IdylbkzN64kK7JPylFce6MuvwnWFR4,11566
+step_rest_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+step_rest_client/rest.py,sha256=wIDkNNb1Whzaduazcn2tDuHI_we5Q4HF4R-GHVB4WWM,14565
+step_rest_client/api/__init__.py,sha256=1SdIBjUFVEzFopfXB-eBgRa5iRIWHjbuZnp2uQQc7NY,1597
+step_rest_client/api/assets_api.py,sha256=zlrVmsHL-H7Azii1t7ghpSDTpaSvJ4fJJdk43_8kMCM,392583
+step_rest_client/api/attributes_api.py,sha256=ONeslOzntZchqI1M1b2dBX1N2nNwFgt3irZMncnz5Qo,18644
+step_rest_client/api/background_process_types_api.py,sha256=Ak7cU18dvB1ZqlSOfI3rQ5eeroMQ1JCp-69QwiV6TvU,31801
+step_rest_client/api/background_processes_api.py,sha256=nwWO-9d__J9AKKdfVrfShqcmVHaAiChzGmFJzOXMyPI,72762
+step_rest_client/api/classifications_api.py,sha256=-bq6Tw0eaXPsfpWdi2-XwX2lwGRs4hhOfQvWSociNHk,406731
+step_rest_client/api/data_container_types_api.py,sha256=OCs2C31v-1izgjpRqcS7SFGQAxDztCwFEzz50_ByoJo,18748
+step_rest_client/api/data_type_groups_api.py,sha256=HeLVBXa3QBot40bIpjdb6P9pkTl6__OIMsO-v6gZq1o,18885
+step_rest_client/api/entities_api.py,sha256=DQ1mWjO5OZdTeGRT4r6b7MF7S9ghj26KsHs5KsTLQ98,432723
+step_rest_client/api/event_processors_api.py,sha256=0H1Mb8GbnYawwxX1pGAr41mWPrjyXKslbRKhneqolIY,145509
+step_rest_client/api/export_api.py,sha256=bmtRZCYm38M4cAUO6cU8SksM8H4YtAYsmdOFyld8aS8,23547
+step_rest_client/api/gateway_integration_endpoints_api.py,sha256=o9Kedao1S3iQ4Zpz8DICoDsR9bsaO6lOThWpf6ReKWI,57002
+step_rest_client/api/import_api.py,sha256=vHBTbau9APzzDw2Jf_m6-UBqjpFzVUxWF5hf9IknxkQ,22063
+step_rest_client/api/inbound_integration_endpoints_api.py,sha256=zY3humQOCM1rP4vPFXoz1n91pKlo50NvKDNjKdkvoYo,125525
+step_rest_client/api/lists_of_values_api.py,sha256=ElG8Dvu0ikTW-auf2nAuiuGX1R3SUFEjL4ZupyaUJx0,32150
+step_rest_client/api/object_types_api.py,sha256=IYYr7QndjnbymBYnL1WoEeV7_6V1uvvkaLYnPJpvn-8,18672
+step_rest_client/api/outbound_integration_endpoints_api.py,sha256=-VDeGqNdSTvRObFGxJfyyV_TvRfLBqPr2PE_lLr4Quk,163241
+step_rest_client/api/products_api.py,sha256=JFQO5MHwAiPXdZbubQKxXkZtH65qTyfXhns5gdGKT90,404721
+step_rest_client/api/reference_types_api.py,sha256=OYxKjSXyr0j2WdY3ksuV1cqVJkEV-cd67CKXuFMU7wE,19101
+step_rest_client/api/reporting_api.py,sha256=oZSntv26AH2Q5yYOIB1dUmKWgX2ccoDdxgb_iyBiI0U,40075
+step_rest_client/api/units_api.py,sha256=SfxBDorgpivfXPfLGS1EZALlfM4kR0pGPIu1ToJyeRM,18504
+step_rest_client/api/workflow_tasks_api.py,sha256=Nj4eM-aj6psNNKRotyZs6bdWU9mToA_4pUcL10oSWUg,82762
+step_rest_client/api/workflows_api.py,sha256=oBMB0Cc8xg0PtqVFmabOxdOkR7isyKfB_XMz5JpEaDo,56807
+step_rest_client/models/__init__.py,sha256=4pLGvXoKUifN8fHFus2X4JmMM-uVOQ_esMsNTgtQJg0,11556
+step_rest_client/models/amount.py,sha256=IV2ap4-uxaIwt0Yg3YQFsgTMnrT0rJUH-hVhboKKVc4,7712
+step_rest_client/models/and_condition.py,sha256=TZiMSZs1xKonekzj5LgVYXEB_hvkPLXcwv8PUFlumhA,9123
+step_rest_client/models/approval_response.py,sha256=upzl6ImeO1Zzdu9T9C5XRORKw4bOKR9JPyGDqxO7cM4,7906
+step_rest_client/models/approval_status.py,sha256=7eQiijHj4FjahIsiIi_uZ6O5dLTkB7nHk87uCfBBIVA,8283
+step_rest_client/models/asset.py,sha256=4CHtmxEvhqGo9ipTN3YzIym7EZYB9nvRHtA7uBF78BA,10380
+step_rest_client/models/attribute.py,sha256=RcAoVEzLHwWPkKSGfZyWDQ-p_YcuvhhDmMUT1z8PE7Y,10285
+step_rest_client/models/attribute_link.py,sha256=VDfWu-EiJVs9MdTRPV-FrSSR1PFdDS765EffCekof9w,8612
+step_rest_client/models/background_process.py,sha256=8czIYt4bPKY5OGkYUe-HL2wPE5NwwbQlLp_uEYciJ0g,11002
+step_rest_client/models/background_process_attachment_metadata.py,sha256=YGWf5LIJSx2V6HHiX56Lz-GeL_4e6B7FdtCdxNVTCfk,9064
+step_rest_client/models/background_process_identification.py,sha256=5o3sUOEjMmcD15mVxyKkcARGk8i9Icw7Ncb3GwFEQvg,7796
+step_rest_client/models/background_process_type.py,sha256=NWfOATIz9eLyUpQ95_jwWZvcilY7yFHmuZJozlvh67o,7755
+step_rest_client/models/classification.py,sha256=UZ9wYWDbZOwbOl9Ajdc5HN1-k_Vr-WzECUw0QWBeBgc,10774
+step_rest_client/models/condition.py,sha256=YwztBACxPEZ4Hrx7KU1Tqd3LqvRioTdi1qIVeK0ulzw,18357
+step_rest_client/models/data_container.py,sha256=nKGaQvZat0iA8S39Wd85WHCP4egA92uXNp4SeaoyxEc,10816
+step_rest_client/models/data_container_entry.py,sha256=49lIh3UOFoVTT5LdQ0WK7mAIC-LxdfMMv5QwurKslMA,9463
+step_rest_client/models/data_container_object_condition.py,sha256=lhZSbkhGcNjz5VkFawALIfTbZa0R3K-SwpUKKrh5Ooo,13374
+step_rest_client/models/data_container_type.py,sha256=4WmgpP2OTwdaV8zqhz6SwvNrkwn0I8dpxYcOQrk-Au4,8945
+step_rest_client/models/data_type_group.py,sha256=qtbJPNz_j02oe6I6vD3MNeds3dJyrkqiYEI3a3sdCN0,8903
+step_rest_client/models/endpoint_statistics.py,sha256=EzV7C1yKlckhw21EogWR9QiIHUH5u4BbEOzFgsq_XTA,10109
+step_rest_client/models/endpoint_status.py,sha256=DWzKkfv7_PgUCUaoHAdNTVVu6KO2i95m0mXM1blnSHw,8119
+step_rest_client/models/entity.py,sha256=QT09PYywMs9Mpe2UH5And0pfkgS5Z-OFTz-PUEh6Bbk,11075
+step_rest_client/models/error.py,sha256=w7eers6J6ZyAdLRaAJX-0qbbt7SAFeOCY5QGei4SbQ4,8144
+step_rest_client/models/event_processor.py,sha256=ICqlwx0BBGMUivbIlw_dFcmHYT_-GqJLBk0Qc63Oego,7943
+step_rest_client/models/event_processor_statistics.py,sha256=JJFurgOmwWipNkIGcKnAmfiWlGsEu6Q9NQNQUHfXa2M,8589
+step_rest_client/models/event_processor_status.py,sha256=Z1q6dkbplsrsdlznVLURea0vkUHBPpou11RdjuK_Bxo,8122
+step_rest_client/models/event_queue_status.py,sha256=ihbr80bu0Tx6_p3gR1VFqFNO0Vm9iegy3MGT3M266mc,7822
+step_rest_client/models/execution_report_entry.py,sha256=C-tOORSE-lAQxfCCAGV11ddMR4T-NZLSmL3Ywjlo1Ic,8445
+step_rest_client/models/export_specification.py,sha256=d-09XLXq5-jjft8UpBuAhYA_Vtxw4kfxZWgHUyVU7Js,8193
+step_rest_client/models/find_similar_business_rule_result.py,sha256=kzI4XdZmWyljOql6vK3RP-2EirGRl4EpjImw8zbTRqo,8409
+step_rest_client/models/find_similar_entities_request.py,sha256=4RA7ioa1uva2IMyWea1hUQvC4H9i6rWeW4xkiaFNW-8,8351
+step_rest_client/models/find_similar_entities_response.py,sha256=7CqRIXbw4n-wDASdZV2QNoOywANCNvPF1l65GTgOkV4,9290
+step_rest_client/models/find_similar_entities_response_record.py,sha256=C3b-nf24_VdJ9Jjvk7y98aHNix6quLYQZFxcNTrfJ3Y,8255
+step_rest_client/models/find_similar_execution_report.py,sha256=3nDACsZKwyiZ8zeefLOmB9fm0M4Ht3mJMjRpBBNJX-0,9422
+step_rest_client/models/gateway_integration_endpoint.py,sha256=EOwBIY5ytb-DQUnil68Vc3fac5fFnpKK4MPPrOrHOAY,8018
+step_rest_client/models/has_data_container_object_condition.py,sha256=Pfev1l_35b_xiFLsvAYKlJNAHU9pvdrtIESoTeNod7c,9621
+step_rest_client/models/has_reference_to_condition.py,sha256=Z6lpc1sWKDjePDk8nniTDC-rZaNjBHMRDIxnTzImesc,9878
+step_rest_client/models/id_condition.py,sha256=DVG8w1cU-AOj-C_B7s4cOdkMFYCUS33PVqauTEDhNbQ,9251
+step_rest_client/models/inbound_integration_endpoint.py,sha256=xhm8zDwhKCGMKYhcs21QCnwaZRuPTnsMeceIoxpUQOk,8018
+step_rest_client/models/incoming_reference_entry.py,sha256=7AvYnIssw6FJt9xLjtX8gnqlzN5b2Myob--QXZr89Fo,9383
+step_rest_client/models/list_of_values.py,sha256=rIGIUzvzrMY1ivUDaSnKZBCkcUwpXYjaF8RkEMYVCsA,9310
+step_rest_client/models/list_of_values_entry.py,sha256=_QRCVP3RzIaBIH8GwanZjiHtG08UGO-4uwj9vC4YM3Y,8012
+step_rest_client/models/lov_value_condition.py,sha256=vSyVs7tdO0PEArVT_v4IQ7hoxjkSatEATcXgN9lSVZM,9030
+step_rest_client/models/match_and_merge_execution_report.py,sha256=rQXaZidgjPB-g3j0lkpU3PMKCMxtDZhbsJIEahufgT0,10050
+step_rest_client/models/match_and_merge_general_execution_report.py,sha256=sYvEfCkIWEs5peyO-k2Z8RWNUyknki0-PjN7b9psiP8,8212
+step_rest_client/models/match_and_merge_potential_duplicate.py,sha256=5HGMFoUvo_I0u2b97JkSgsx9x-BPKVmHAITqKVDLwv4,8084
+step_rest_client/models/match_and_merge_record_in.py,sha256=v14Q-1poEq-ez-rObaQoNdUPYPhnrXHYxs_4aRDFaCI,8228
+step_rest_client/models/match_and_merge_record_out.py,sha256=Elx-XqfJLhIjC5TDem0O3eR1qiA5FF8aKrYrzFD1nAI,10212
+step_rest_client/models/match_and_merge_response.py,sha256=AGD9Opjj_A25vuRBO8g_P9uQmWLdC9-RlJu7Au1z87s,9487
+step_rest_client/models/multi_data_container.py,sha256=5MCRXfDUg3WZHKVKXvafZdQSOU-0ejo-crtvz9uYd-U,8722
+step_rest_client/models/multi_reference.py,sha256=pl5XDhN-Lje_YFF7iai3-OumKgbPO5TsqvCgjKhBJw0,8399
+step_rest_client/models/multi_value.py,sha256=qWZdhQ0FfA8eqD3Xs8R3e3PeRY4bB6r45jZSQwrQcAA,8975
+step_rest_client/models/name_condition.py,sha256=LikONQCjIx8glPGyfy7mW11i8IqUNn3yNneiU5bAZ94,9529
+step_rest_client/models/numeric_value_condition.py,sha256=OG6RzA0XQisYteDWTd8QM_fsZoBoZ9nhYkAhgL4jtYk,9973
+step_rest_client/models/object_type.py,sha256=d9IKxEhHKlToZqyDNNFryfyxLqOMk8x9dp2ju7Vpwfs,8633
+step_rest_client/models/object_type_condition.py,sha256=L289WF2ofWd-XhFEeKZXNpgBTniGXBb_pw0gEunpeTo,8450
+step_rest_client/models/or_condition.py,sha256=0TujUrj3Za6drQceM-Rlcoc5CR_CV5EcmO9R1pJsSKI,9116
+step_rest_client/models/outbound_integration_endpoint.py,sha256=j1ktEhny-XX-UVT-BR9sIKgEEzPPRr6RWhWIOVvpfcc,8024
+step_rest_client/models/product.py,sha256=zre0RB4WtTwjcrHU_QVNyFo7eOd8cCwawTlY0hxBUFw,11780
+step_rest_client/models/query.py,sha256=FbPyJAEWoIVL-GfwH81FAIjumHV-AQk5ofKe1XRIJpc,7935
+step_rest_client/models/query_result.py,sha256=RvlKS-f5Kf8ojMhQkSi7m289Nc8kAJVa0WzF9v-kh4U,8214
+step_rest_client/models/reference.py,sha256=v8cxYKfybkzfLvzLcNqmGvh7aopWOKpYuZ6qlDTep14,10657
+step_rest_client/models/reference_entry.py,sha256=EO1nRm6KAKNkjr68QKmvt3O6mi7xjOllCaHBDnLCPWw,11377
+step_rest_client/models/reference_metadata_condition.py,sha256=sXvAiDkl5W3lqgLZ6YmpM3ATMN3qoex3vvHpOekFQkk,13351
+step_rest_client/models/reference_type.py,sha256=nQw6R5lltG8R-bDeAxExqcqdHck3C5xa45zR_K8_IHA,10074
+step_rest_client/models/rejected_by_business_condition.py,sha256=6U8sv5hfFSD9ApaEt0BiqDVprFhFrAE5piwPJkUOmCU,8426
+step_rest_client/models/simple_below_condition.py,sha256=n7mpoBWUSsHqso3AK3UEXicZyY3Qf0ax4huWssdWTP8,8960
+step_rest_client/models/single_data_container.py,sha256=0XSkZavmWQMC4xH1RS_FW98U_dzl1jY4MUd-a6sHK6o,8456
+step_rest_client/models/single_reference.py,sha256=76OCCZYPMWxJASgXZhhwS46uPPCdTc2vY2dj754bc8k,8113
+step_rest_client/models/single_value.py,sha256=SoZvoZyuMNH1-gXQWrjCeJswJ4iL-yzZtdvFmHxK5R4,9088
+step_rest_client/models/status_flag.py,sha256=pPfZ-NsTPcVf4fMhvAQ-YscAhxvY0WbOkkHZYejWYsw,7776
+step_rest_client/models/text_value_condition.py,sha256=N8Y770zzBhpIElgjUXIE6Gp1hLG2X4yRsD-FefMZHkM,10101
+step_rest_client/models/trigger_workflow_event.py,sha256=_l3fkSnJI85FJt-DDbb9xC5uwgFxibWwrKscOE523uM,8120
+step_rest_client/models/unit.py,sha256=zOhJcgOrPRDL1_2513yR3wlgS0sCHBOMmjJBVxRUAow,8586
+step_rest_client/models/value.py,sha256=y6qY8gG-FLaB634lnfWrB2EXE5vr9rU4cuoIBjgbka8,10363
+step_rest_client/models/value_entry.py,sha256=QBpQmc4FFTd0XVPIftCi2yhUb78kCOwwI5DfKYnIG9c,8295
+step_rest_client/models/workflow.py,sha256=orEZcSvut0NyyVpi3y9fbcEBfY0akrZ_JDcHQHroTsE,8022
+step_rest_client/models/workflow_event.py,sha256=yphi3G2fkOmYP59g9nH_B77SgbPaFGrVinOOn97TyVo,7959
+step_rest_client/models/workflow_instance.py,sha256=n6WOQvHLI7mDNj-g7hdiPnYl6JC3Wk__2WZ5ajAW5GY,7679
+step_rest_client/models/workflow_instance_creation.py,sha256=eRDunOq0AWScsF7YL8e4jC0bLOhfNozKwTK9Pj4HT8I,8135
+step_rest_client/models/workflow_node.py,sha256=HAS3t8cxjd_wepiu0IyFrh5iWAEQjBLQvZ6Z5JI0Oao,8230
+step_rest_client/models/workflow_task.py,sha256=Q26zgU_iiErYuokAF8_KdtvbIRanJPfxSx6OH6blmiU,10008
+step_rest_client/models/workflow_task_query.py,sha256=pR4aHzB2kRyinSS5ZmN6Qsw5F5d_6EYRcjwi931IsJ0,9543
+step_rest_client-1.0.0.dist-info/METADATA,sha256=h9nF7GCTWtrMB3qXZ6I-QKqraX_r080wPQuPyKHEJ6U,6424
+step_rest_client-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+step_rest_client-1.0.0.dist-info/top_level.txt,sha256=D1sOIzUOKzVH1gx1BcUqbOTd7deig2GWYIc8-ydAoGQ,17
+step_rest_client-1.0.0.dist-info/RECORD,,

step_rest_client-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

step_rest_client-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+step_rest_client