Merge pull request #28 from Authress/wparad/remove-legacy-parameter

Remove legacy parameter if_unmodified_since. fix #27

Author: wparad

CHANGELOG.md

@@ -1,9 +1,6 @@
 # Change log
 This is the changelog for [Authress SDK](readme.md).
 
-## 4.0 ##
-* [Breaking] Renamed parameter `if_unmodified_since` in the Access Record API to be `expected_last_modified_time`.
-
 ## 3.0 ##
 * [Breaking] Added type checking everywhere - This means most models have breaking changes.
 * [Breaking] Converted properties to be consistent across all generators
@@ -13,6 +10,7 @@ This is the changelog for [Authress SDK](readme.md).
 * [Breaking] Moved `authress_client.clients` api to `authress_client.service_clients`.
 * [Breaking] Renamed `AccessRecordStatement` model to `Statement` in `models.statement.py`.
 * [Breaking] Renamed `AccessRecordResource` model to `Resource` in `models.resource.py`.
+* [Breaking] Renamed parameter `if_unmodified_since` in the Access Record API to be `expected_last_modified_time`.
 * Add missing `If-Unmodified-Since` support to the `update_group` in the `Groups` API.
 * Improve caching in `verify_token`
 * Support additionally pydantic v2 dependencies. Support for v1 will be removed in a future version.

authress/api/access_records_api.py

@@ -1622,7 +1622,6 @@ def update_record_with_http_info(self,
         _all_params = [
             'record_id',
             'access_record',
-            'if_unmodified_since',
             'expected_last_modified_time'
         ]
         _all_params.extend(
@@ -1659,8 +1658,6 @@ def update_record_with_http_info(self,
         _query_params = []
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
-        if _params['if_unmodified_since']:
-            _header_params['If-Unmodified-Since'] = _params['if_unmodified_since']
         if _params['expected_last_modified_time']:
             _header_params['If-Unmodified-Since'] = _params['expected_last_modified_time']
 

authress/rest.py

@@ -164,7 +164,7 @@ def request(self, method, url, query_params=None, headers=None,
                     msg = """Cannot prepare a request message for provided
                              arguments. Please check that your arguments match
                              declared content type."""
-                    raise ServiceException(status=0, reason=msg)
+                    raise ApiException(status=0, reason=msg)
             # For `GET`, `HEAD`, `QUERY`
             else:
                 r = self.pool_manager.request(method, url,
@@ -174,10 +174,10 @@ def request(self, method, url, query_params=None, headers=None,
                                               headers=headers)
         except urllib3.exceptions.SSLError as e:
             msg = "{0}\n{1}".format(type(e).__name__, str(e))
-            raise ServiceException(status=0, reason=msg)
+            raise ApiException(status=0, reason=msg)
         except Exception as e:
           msg = "{0}\n{1}".format(type(e).__name__, str(e))
-          raise ServiceException(status=0, reason=msg)
+          raise ApiException(status=0, reason=msg)
 
         if _preload_content:
             r = RESTResponse(r)
@@ -201,7 +201,7 @@ def request(self, method, url, query_params=None, headers=None,
             if 500 <= r.status <= 599:
                 raise ServiceException(http_resp=r)
 
-            raise ServiceException(http_resp=r)
+            raise ApiException(http_resp=r)
 
         return r
 

docs/AccessRecord.md

@@ -24,16 +24,24 @@ Name | Type | Description | Notes
 ```python
 from authress.models.access_record import AccessRecord
 
-json = "{}"
-# create an instance of AccessRecord from a JSON string
-access_record_instance = AccessRecord.from_json(json)
-# print the JSON string representation of the object
-print AccessRecord.to_json()
-
-# convert the object into a dict
-access_record_dict = access_record_instance.to_dict()
-# create an instance of AccessRecord from a dict
-access_record_from_dict = AccessRecord.from_dict(access_record_dict)
+access_record = AccessRecord(
+    record_id='rec_new_record',
+    name="Permissions Example",
+    users=[
+        User(user_id="user_id")
+    ],
+    admins=[
+        User(user_id="admin_user_id")
+    ],
+    statements=[
+        Statement(
+            roles=["Authress:Owner"],
+            resources=[
+                Resource(resourceUri="/documents/test_document_id")
+            ]
+        )
+    ]
+) 
 ```
 [[API Models]](./README.md#documentation-for-models) ☆ [[API Endpoints]](./README.md#documentation-for-api-endpoints) ☆ [[Back to Repo]](../README.md)
 

docs/AccessRecordsApi.md

@@ -109,7 +109,21 @@ authress_api_url = "https://authress.yourdomain.com" # or "https://ACCOUNT_ID.ap
 service_client_access_key = "sc_key_001"
 authress_client = AuthressClient(authress_api_url=authress_api_url , service_client_access_key=service_client_access_key)
 
-    access_record = authress.AccessRecord() # AccessRecord |
+    access_record = AccessRecord(
+      record_id='rec_record_id',
+      name="Permissions example",
+      users=[
+        User(user_id="user_id_1")
+      ],
+      statements=[
+        Statement(
+          roles=["ro_viewer"],
+          resources=[
+            Resource(resourceUri="/documents/test_document_id")
+          ]
+        )
+      ]
+    )
 
     try:
         # Create access record

docs/GroupsApi.md

@@ -284,7 +284,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **update_group**
-> Group update_group(group_id, group, if_unmodified_since=if_unmodified_since)
+> Group update_group(group_id, group, expected_last_modified_time=expected_last_modified_time)
 
 Update a group
 

docs/Statement.md

@@ -14,16 +14,12 @@ Name | Type | Description | Notes
 ```python
 from authress.models.statement import Statement
 
-json = "{}"
-# create an instance of Statement from a JSON string
-statement_instance = Statement.from_json(json)
-# print the JSON string representation of the object
-print Statement.to_json()
-
-# convert the object into a dict
-statement_dict = statement_instance.to_dict()
-# create an instance of Statement from a dict
-statement_from_dict = Statement.from_dict(statement_dict)
+statement = Statement(
+    roles=["ro_viewer"],
+    resources=[
+        Resource(resourceUri="/accounts/acc_001/documents/*")
+    ]
+)
 ```
 [[API Models]](./README.md#documentation-for-models) ☆ [[API Endpoints]](./README.md#documentation-for-api-endpoints) ☆ [[Back to Repo]](../README.md)