rxfoundry.clients.swifty-receiver-api 1.0.0__tar.gz

rxfoundry_clients_swifty_receiver_api-1.0.0/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: rxfoundry.clients.swifty-receiver-api
+Version: 1.0.0
+Summary: Swifty Receiver API
+Home-page: 
+Author: RxFoundry Team
+Author-email: paul.tindall@rxfoundry.com
+Keywords: OpenAPI,OpenAPI-Generator,Swifty Receiver API
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+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
+
+    API for the Swifty Receiver 
+    

rxfoundry_clients_swifty_receiver_api-1.0.0/README.md

@@ -0,0 +1,124 @@
+# rxfoundry.clients.swifty-receiver-api
+API for the Swifty Receiver
+
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 0.1.DEV-0
+- Package version: 1.0.0
+- Generator version: 7.13.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.9+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import rxfoundry.clients.swifty_receiver_api
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import rxfoundry.clients.swifty_receiver_api
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import rxfoundry.clients.swifty_receiver_api
+from rxfoundry.clients.swifty_receiver_api.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = rxfoundry.clients.swifty_receiver_api.Configuration(
+    host = "/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (opaque): opaque_token
+configuration = rxfoundry.clients.swifty_receiver_api.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+
+# Enter a context with an instance of the API client
+with rxfoundry.clients.swifty_receiver_api.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = rxfoundry.clients.swifty_receiver_api.AsyncApi(api_client)
+    message = rxfoundry.clients.swifty_receiver_api.Message() # Message | 
+
+    try:
+        # Post a new message asynchronously
+        api_response = api_instance.create_message(message)
+        print("The response of AsyncApi->create_message:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AsyncApi->create_message: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to */api*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AsyncApi* | [**create_message**](docs/AsyncApi.md#create_message) | **POST** /receiver/1/async/message | Post a new message asynchronously
+*VersionApi* | [**get_version**](docs/VersionApi.md#get_version) | **GET** /receiver/1/version | Get the api version
+
+
+## Documentation For Models
+
+ - [AsynchronousResponse](docs/AsynchronousResponse.md)
+ - [Message](docs/Message.md)
+ - [Version](docs/Version.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="opaque_token"></a>
+### opaque_token
+
+- **Type**: Bearer authentication (opaque)
+
+
+## Author
+
+paul.tindall@rxfoundry.com
+
+

rxfoundry_clients_swifty_receiver_api-1.0.0/pyproject.toml

@@ -0,0 +1,89 @@
+[tool.poetry]
+name = "rxfoundry.clients.swifty_receiver_api"
+version = "1.0.0"
+description = "Swifty Receiver API"
+authors = ["RxFoundry Team <paul.tindall@rxfoundry.com>"]
+license = "NoLicense"
+readme = "README.md"
+repository = "https://github.com/GIT_USER_ID/GIT_REPO_ID"
+keywords = ["OpenAPI", "OpenAPI-Generator", "Swifty Receiver API"]
+include = ["rxfoundry.clients.swifty_receiver_api/py.typed"]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+
+urllib3 = ">= 2.1.0, < 3.0.0"
+python-dateutil = ">= 2.8.2"
+pydantic = ">= 2"
+typing-extensions = ">= 4.7.1"
+
+[tool.poetry.dev-dependencies]
+pytest = ">= 7.2.1"
+pytest-cov = ">= 2.8.1"
+tox = ">= 3.9.0"
+flake8 = ">= 4.0.0"
+types-python-dateutil = ">= 2.8.19.14"
+mypy = ">= 1.5"
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"
+
+[tool.mypy]
+files = [
+  "rxfoundry.clients.swifty_receiver_api",
+  #"test",  # auto-generated tests
+  "tests", # hand-written tests
+]
+# TODO: enable "strict" once all these individual checks are passing
+# strict = true
+
+# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+## Getting these passing should be easy
+strict_equality = true
+extra_checks = true
+
+## Strongly recommend enabling this one as soon as you can
+check_untyped_defs = true
+
+## These shouldn't be too much additional work, but may be tricky to
+## get passing if you use a lot of untyped libraries
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+
+### These next few are various gradations of forcing use of type annotations
+#disallow_untyped_calls = true
+#disallow_incomplete_defs = true
+#disallow_untyped_defs = true
+#
+### This one isn't too hard to get passing, but return on investment is lower
+#no_implicit_reexport = true
+#
+### This one can be tricky to get passing if you use a lot of untyped libraries
+#warn_return_any = true
+
+[[tool.mypy.overrides]]
+module = [
+  "rxfoundry.clients.swifty_receiver_api.configuration",
+]
+warn_unused_ignores = true
+strict_equality = true
+extra_checks = true
+check_untyped_defs = true
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+disallow_untyped_calls = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_reexport = true
+warn_return_any = true

rxfoundry_clients_swifty_receiver_api-1.0.0/rxfoundry/clients/swifty_receiver_api/__init__.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Swifty Receiver API
+
+    API for the Swifty Receiver 
+
+    The version of the OpenAPI document: 0.1.DEV-0
+    Contact: paul.tindall@rxfoundry.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# import apis into sdk package
+from rxfoundry.clients.swifty_receiver_api.api.async_api import AsyncApi
+from rxfoundry.clients.swifty_receiver_api.api.version_api import VersionApi
+
+# import ApiClient
+from rxfoundry.clients.swifty_receiver_api.api_response import ApiResponse
+from rxfoundry.clients.swifty_receiver_api.api_client import ApiClient
+from rxfoundry.clients.swifty_receiver_api.configuration import Configuration
+from rxfoundry.clients.swifty_receiver_api.exceptions import OpenApiException
+from rxfoundry.clients.swifty_receiver_api.exceptions import ApiTypeError
+from rxfoundry.clients.swifty_receiver_api.exceptions import ApiValueError
+from rxfoundry.clients.swifty_receiver_api.exceptions import ApiKeyError
+from rxfoundry.clients.swifty_receiver_api.exceptions import ApiAttributeError
+from rxfoundry.clients.swifty_receiver_api.exceptions import ApiException
+
+# import models into sdk package
+from rxfoundry.clients.swifty_receiver_api.models.asynchronous_response import AsynchronousResponse
+from rxfoundry.clients.swifty_receiver_api.models.message import Message
+from rxfoundry.clients.swifty_receiver_api.models.version import Version

rxfoundry_clients_swifty_receiver_api-1.0.0/rxfoundry/clients/swifty_receiver_api/api/__init__.py

@@ -0,0 +1,6 @@
+# flake8: noqa
+
+# import apis into api package
+from rxfoundry.clients.swifty_receiver_api.api.async_api import AsyncApi
+from rxfoundry.clients.swifty_receiver_api.api.version_api import VersionApi
+

rxfoundry_clients_swifty_receiver_api-1.0.0/rxfoundry/clients/swifty_receiver_api/api/async_api.py

@@ -0,0 +1,312 @@
+# coding: utf-8
+
+"""
+    Swifty Receiver API
+
+    API for the Swifty Receiver 
+
+    The version of the OpenAPI document: 0.1.DEV-0
+    Contact: paul.tindall@rxfoundry.com
+    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 rxfoundry.clients.swifty_receiver_api.models.asynchronous_response import AsynchronousResponse
+from rxfoundry.clients.swifty_receiver_api.models.message import Message
+
+from rxfoundry.clients.swifty_receiver_api.api_client import ApiClient, RequestSerialized
+from rxfoundry.clients.swifty_receiver_api.api_response import ApiResponse
+from rxfoundry.clients.swifty_receiver_api.rest import RESTResponseType
+
+
+class AsyncApi:
+    """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 create_message(
+        self,
+        message: Message,
+        _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,
+    ) -> AsynchronousResponse:
+        """Post a new message asynchronously
+
+
+        :param message: (required)
+        :type message: Message
+        :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._create_message_serialize(
+            message=message,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "AsynchronousResponse",
+            '400': None,
+        }
+        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 create_message_with_http_info(
+        self,
+        message: Message,
+        _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[AsynchronousResponse]:
+        """Post a new message asynchronously
+
+
+        :param message: (required)
+        :type message: Message
+        :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._create_message_serialize(
+            message=message,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "AsynchronousResponse",
+            '400': None,
+        }
+        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 create_message_without_preload_content(
+        self,
+        message: Message,
+        _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:
+        """Post a new message asynchronously
+
+
+        :param message: (required)
+        :type message: Message
+        :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._create_message_serialize(
+            message=message,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "AsynchronousResponse",
+            '400': None,
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _create_message_serialize(
+        self,
+        message,
+        _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
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if message is not None:
+            _body_params = message
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'opaque_token'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/receiver/1/async/message',
+            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
+        )
+
+