rxfoundry.clients.swifty_oauth_api 0.0.846__tar.gz → 0.0.848__tar.gz

{rxfoundry_clients_swifty_oauth_api-0.0.846 → rxfoundry_clients_swifty_oauth_api-0.0.848}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rxfoundry.clients.swifty-oauth-api
-Version: 0.0.846
+Version: 0.0.848
 Summary: Swifty OAuth API
 Home-page: 
 Author: RxFoundry Team

{rxfoundry_clients_swifty_oauth_api-0.0.846 → rxfoundry_clients_swifty_oauth_api-0.0.848}/README.md

@@ -68,15 +68,15 @@ configuration = rxfoundry.clients.swifty_oauth_api.Configuration(
 with rxfoundry.clients.swifty_oauth_api.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = rxfoundry.clients.swifty_oauth_api.OAuthApi(api_client)
-    oauth_token_post_request = rxfoundry.clients.swifty_oauth_api.OauthTokenPostRequest() # OauthTokenPostRequest | 
+    get_token_request = rxfoundry.clients.swifty_oauth_api.GetTokenRequest() # GetTokenRequest | 
 
     try:
         # Get a token
-        api_response = api_instance.oauth_token_post(oauth_token_post_request)
-        print("The response of OAuthApi->oauth_token_post:\n")
+        api_response = api_instance.get_token(get_token_request)
+        print("The response of OAuthApi->get_token:\n")
         pprint(api_response)
     except ApiException as e:
-        print("Exception when calling OAuthApi->oauth_token_post: %s\n" % e)
+        print("Exception when calling OAuthApi->get_token: %s\n" % e)
 
 ```
 
@@ -86,13 +86,13 @@ All URIs are relative to *http://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*OAuthApi* | [**oauth_token_post**](docs/OAuthApi.md#oauth_token_post) | **POST** /oauth/token/ | Get a token
-*OAuthApi* | [**oauth_userinfo_post**](docs/OAuthApi.md#oauth_userinfo_post) | **POST** /oauth/userinfo/ | Get user info
+*OAuthApi* | [**get_token**](docs/OAuthApi.md#get_token) | **POST** /oauth/token/ | Get a token
+*OAuthApi* | [**get_user_info**](docs/OAuthApi.md#get_user_info) | **POST** /oauth/userinfo/ | Get user info
 
 
 ## Documentation For Models
 
- - [OauthTokenPostRequest](docs/OauthTokenPostRequest.md)
+ - [GetTokenRequest](docs/GetTokenRequest.md)
  - [TokenResponse](docs/TokenResponse.md)
  - [UserInfoResponse](docs/UserInfoResponse.md)
 
@@ -100,7 +100,12 @@ Class | Method | HTTP request | Description
 <a id="documentation-for-authorization"></a>
 ## Documentation For Authorization
 
-Endpoints do not require authorization.
+
+Authentication schemes defined for the API:
+<a id="opaque_token"></a>
+### opaque_token
+
+- **Type**: Bearer authentication (opaque)
 
 
 ## Author

{rxfoundry_clients_swifty_oauth_api-0.0.846 → rxfoundry_clients_swifty_oauth_api-0.0.848}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rxfoundry.clients.swifty_oauth_api"
-version = "0.0.846"
+version = "0.0.848"
 description = "Swifty OAuth API"
 authors = ["RxFoundry Team <paul.tindall@rxfoundry.com>"]
 license = "NoLicense"

{rxfoundry_clients_swifty_oauth_api-0.0.846 → rxfoundry_clients_swifty_oauth_api-0.0.848}/rxfoundry/clients/swifty_oauth_api/__init__.py

@@ -32,6 +32,6 @@ from rxfoundry.clients.swifty_oauth_api.exceptions import ApiAttributeError
 from rxfoundry.clients.swifty_oauth_api.exceptions import ApiException
 
 # import models into sdk package
-from rxfoundry.clients.swifty_oauth_api.models.oauth_token_post_request import OauthTokenPostRequest
+from rxfoundry.clients.swifty_oauth_api.models.get_token_request import GetTokenRequest
 from rxfoundry.clients.swifty_oauth_api.models.token_response import TokenResponse
 from rxfoundry.clients.swifty_oauth_api.models.user_info_response import UserInfoResponse

{rxfoundry_clients_swifty_oauth_api-0.0.846 → rxfoundry_clients_swifty_oauth_api-0.0.848}/rxfoundry/clients/swifty_oauth_api/api/o_auth_api.py

@@ -17,7 +17,7 @@ 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_oauth_api.models.oauth_token_post_request import OauthTokenPostRequest
+from rxfoundry.clients.swifty_oauth_api.models.get_token_request import GetTokenRequest
 from rxfoundry.clients.swifty_oauth_api.models.token_response import TokenResponse
 from rxfoundry.clients.swifty_oauth_api.models.user_info_response import UserInfoResponse
 
@@ -40,9 +40,9 @@ class OAuthApi:
 
 
     @validate_call
-    def oauth_token_post(
+    def get_token(
         self,
-        oauth_token_post_request: OauthTokenPostRequest,
+        get_token_request: GetTokenRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -59,8 +59,8 @@ class OAuthApi:
         """Get a token
 
 
-        :param oauth_token_post_request: (required)
-        :type oauth_token_post_request: OauthTokenPostRequest
+        :param get_token_request: (required)
+        :type get_token_request: GetTokenRequest
         :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
@@ -83,8 +83,8 @@ class OAuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._oauth_token_post_serialize(
-            oauth_token_post_request=oauth_token_post_request,
+        _param = self._get_token_serialize(
+            get_token_request=get_token_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -107,9 +107,9 @@ class OAuthApi:
 
 
     @validate_call
-    def oauth_token_post_with_http_info(
+    def get_token_with_http_info(
         self,
-        oauth_token_post_request: OauthTokenPostRequest,
+        get_token_request: GetTokenRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -126,8 +126,8 @@ class OAuthApi:
         """Get a token
 
 
-        :param oauth_token_post_request: (required)
-        :type oauth_token_post_request: OauthTokenPostRequest
+        :param get_token_request: (required)
+        :type get_token_request: GetTokenRequest
         :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
@@ -150,8 +150,8 @@ class OAuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._oauth_token_post_serialize(
-            oauth_token_post_request=oauth_token_post_request,
+        _param = self._get_token_serialize(
+            get_token_request=get_token_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -174,9 +174,9 @@ class OAuthApi:
 
 
     @validate_call
-    def oauth_token_post_without_preload_content(
+    def get_token_without_preload_content(
         self,
-        oauth_token_post_request: OauthTokenPostRequest,
+        get_token_request: GetTokenRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -193,8 +193,8 @@ class OAuthApi:
         """Get a token
 
 
-        :param oauth_token_post_request: (required)
-        :type oauth_token_post_request: OauthTokenPostRequest
+        :param get_token_request: (required)
+        :type get_token_request: GetTokenRequest
         :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
@@ -217,8 +217,8 @@ class OAuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._oauth_token_post_serialize(
-            oauth_token_post_request=oauth_token_post_request,
+        _param = self._get_token_serialize(
+            get_token_request=get_token_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -236,9 +236,9 @@ class OAuthApi:
         return response_data.response
 
 
-    def _oauth_token_post_serialize(
+    def _get_token_serialize(
         self,
-        oauth_token_post_request,
+        get_token_request,
         _request_auth,
         _content_type,
         _headers,
@@ -264,8 +264,8 @@ class OAuthApi:
         # process the header parameters
         # process the form parameters
         # process the body parameter
-        if oauth_token_post_request is not None:
-            _body_params = oauth_token_post_request
+        if get_token_request is not None:
+            _body_params = get_token_request
 
 
         # set the HTTP header `Accept`
@@ -313,7 +313,7 @@ class OAuthApi:
 
 
     @validate_call
-    def oauth_userinfo_post(
+    def get_user_info(
         self,
         _request_timeout: Union[
             None,
@@ -353,7 +353,7 @@ class OAuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._oauth_userinfo_post_serialize(
+        _param = self._get_user_info_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -376,7 +376,7 @@ class OAuthApi:
 
 
     @validate_call
-    def oauth_userinfo_post_with_http_info(
+    def get_user_info_with_http_info(
         self,
         _request_timeout: Union[
             None,
@@ -416,7 +416,7 @@ class OAuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._oauth_userinfo_post_serialize(
+        _param = self._get_user_info_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -439,7 +439,7 @@ class OAuthApi:
 
 
     @validate_call
-    def oauth_userinfo_post_without_preload_content(
+    def get_user_info_without_preload_content(
         self,
         _request_timeout: Union[
             None,
@@ -479,7 +479,7 @@ class OAuthApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._oauth_userinfo_post_serialize(
+        _param = self._get_user_info_serialize(
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -497,7 +497,7 @@ class OAuthApi:
         return response_data.response
 
 
-    def _oauth_userinfo_post_serialize(
+    def _get_user_info_serialize(
         self,
         _request_auth,
         _content_type,
@@ -537,6 +537,7 @@ class OAuthApi:
 
         # authentication setting
         _auth_settings: List[str] = [
+            'opaque_token'
         ]
 
         return self.api_client.param_serialize(

{rxfoundry_clients_swifty_oauth_api-0.0.846 → rxfoundry_clients_swifty_oauth_api-0.0.848}/rxfoundry/clients/swifty_oauth_api/configuration.py

@@ -114,6 +114,7 @@ HTTPSignatureAuthSetting = TypedDict(
 AuthSettings = TypedDict(
     "AuthSettings",
     {
+        "opaque_token": BearerFormatAuthSetting,
     },
     total=False,
 )
@@ -164,6 +165,7 @@ class Configuration:
     :param ca_cert_data: verify the peer using concatenated CA certificate data
       in PEM (str) or DER (bytes) format.
 
+    :Example:
     """
 
     _default: ClassVar[Optional[Self]] = None
@@ -491,6 +493,14 @@ class Configuration:
         :return: The Auth Settings information dict.
         """
         auth: AuthSettings = {}
+        if self.access_token is not None:
+            auth['opaque_token'] = {
+                'type': 'bearer',
+                'in': 'header',
+                'format': 'opaque',
+                'key': 'Authorization',
+                'value': 'Bearer ' + self.access_token
+            }
         return auth
 
     def to_debug_report(self) -> str:

{rxfoundry_clients_swifty_oauth_api-0.0.846 → rxfoundry_clients_swifty_oauth_api-0.0.848}/rxfoundry/clients/swifty_oauth_api/models/__init__.py

@@ -15,6 +15,6 @@
 
 
 # import models into model package
-from rxfoundry.clients.swifty_oauth_api.models.oauth_token_post_request import OauthTokenPostRequest
+from rxfoundry.clients.swifty_oauth_api.models.get_token_request import GetTokenRequest
 from rxfoundry.clients.swifty_oauth_api.models.token_response import TokenResponse
 from rxfoundry.clients.swifty_oauth_api.models.user_info_response import UserInfoResponse

rxfoundry_clients_swifty_oauth_api-0.0.848/rxfoundry/clients/swifty_oauth_api/models/get_token_request.py

@@ -0,0 +1,94 @@
+# coding: utf-8
+
+"""
+    Swifty OAuth API
+
+    API for the Swifty OAuth Backend 
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: paul.tindall@rxfoundry.com
+    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 GetTokenRequest(BaseModel):
+    """
+    GetTokenRequest
+    """ # noqa: E501
+    grant_type: Optional[StrictStr] = Field(default=None, description="Either 'password' or 'refresh_token'")
+    username: Optional[StrictStr] = Field(default=None, description="Required if grant_type is 'password'")
+    password: Optional[StrictStr] = Field(default=None, description="Required if grant_type is 'password'")
+    refresh_token: Optional[StrictStr] = Field(default=None, description="Required if grant_type is 'refresh_token'")
+    __properties: ClassVar[List[str]] = ["grant_type", "username", "password", "refresh_token"]
+
+    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 GetTokenRequest 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 GetTokenRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "grant_type": obj.get("grant_type"),
+            "username": obj.get("username"),
+            "password": obj.get("password"),
+            "refresh_token": obj.get("refresh_token")
+        })
+        return _obj
+
+

{rxfoundry_clients_swifty_oauth_api-0.0.846 → rxfoundry_clients_swifty_oauth_api-0.0.848}/rxfoundry/clients/swifty_oauth_api/models/user_info_response.py

@@ -35,7 +35,8 @@ class UserInfoResponse(BaseModel):
     name: Optional[StrictStr] = None
     permissions: Optional[List[StrictStr]] = None
     user_groups: Optional[List[StrictStr]] = None
-    __properties: ClassVar[List[str]] = ["sub", "email", "given_name", "family_name", "preferred_username", "name", "permissions", "user_groups"]
+    npi: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["sub", "email", "given_name", "family_name", "preferred_username", "name", "permissions", "user_groups", "npi"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -95,7 +96,8 @@ class UserInfoResponse(BaseModel):
             "preferred_username": obj.get("preferred_username"),
             "name": obj.get("name"),
             "permissions": obj.get("permissions"),
-            "user_groups": obj.get("user_groups")
+            "user_groups": obj.get("user_groups"),
+            "npi": obj.get("npi")
         })
         return _obj
 

{rxfoundry_clients_swifty_oauth_api-0.0.846 → rxfoundry_clients_swifty_oauth_api-0.0.848}/rxfoundry.clients.swifty_oauth_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rxfoundry.clients.swifty-oauth-api
-Version: 0.0.846
+Version: 0.0.848
 Summary: Swifty OAuth API
 Home-page: 
 Author: RxFoundry Team

{rxfoundry_clients_swifty_oauth_api-0.0.846 → rxfoundry_clients_swifty_oauth_api-0.0.848}/rxfoundry.clients.swifty_oauth_api.egg-info/SOURCES.txt

@@ -19,9 +19,11 @@ rxfoundry/clients/swifty_oauth_api/rest.py
 rxfoundry/clients/swifty_oauth_api/api/__init__.py
 rxfoundry/clients/swifty_oauth_api/api/o_auth_api.py
 rxfoundry/clients/swifty_oauth_api/models/__init__.py
+rxfoundry/clients/swifty_oauth_api/models/get_token_request.py
 rxfoundry/clients/swifty_oauth_api/models/oauth_token_post_request.py
 rxfoundry/clients/swifty_oauth_api/models/token_response.py
 rxfoundry/clients/swifty_oauth_api/models/user_info_response.py
+test/test_get_token_request.py
 test/test_o_auth_api.py
 test/test_oauth_token_post_request.py
 test/test_token_response.py

{rxfoundry_clients_swifty_oauth_api-0.0.846 → rxfoundry_clients_swifty_oauth_api-0.0.848}/setup.py

@@ -22,7 +22,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "rxfoundry.clients.swifty-oauth-api"
-VERSION = "0.0.846"
+VERSION = "0.0.848"
 PYTHON_REQUIRES = ">= 3.9"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",

rxfoundry_clients_swifty_oauth_api-0.0.848/test/test_get_token_request.py

@@ -0,0 +1,55 @@
+# coding: utf-8
+
+"""
+    Swifty OAuth API
+
+    API for the Swifty OAuth Backend 
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: paul.tindall@rxfoundry.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from rxfoundry.clients.swifty_oauth_api.models.get_token_request import GetTokenRequest
+
+class TestGetTokenRequest(unittest.TestCase):
+    """GetTokenRequest unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> GetTokenRequest:
+        """Test GetTokenRequest
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `GetTokenRequest`
+        """
+        model = GetTokenRequest()
+        if include_optional:
+            return GetTokenRequest(
+                grant_type = '',
+                username = '',
+                password = '',
+                refresh_token = ''
+            )
+        else:
+            return GetTokenRequest(
+        )
+        """
+
+    def testGetTokenRequest(self):
+        """Test GetTokenRequest"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()