feat: better typing by generating from updated schema, update usage e…

…xamples
Orkuncakilkaya · Jul 29, 2022 · cb5208d · cb5208d
1 parent 5db8fdc
commit cb5208d
Show file tree

Hide file tree

Showing 23 changed files with 180 additions and 478 deletions.
diff --git a/README.md b/README.md
@@ -65,6 +65,7 @@ Please follow the [installation procedure](#installation--usage) and then run th
 ```python
 from __future__ import print_function
 import swagger_client
+from swagger_client import Response
 from swagger_client.rest import ApiException
 from pprint import pprint
 
@@ -81,7 +82,7 @@ limit = 10  # int | Limit scanned results (optional)
 #before = 56  # int | Used to paginate results (optional)
 
 try:
-    api_response = api_instance.visitors_visitor_id_get(visitor_id, limit=limit)
+    api_response: Response = api_instance.get_visits(visitor_id, limit=2)
     pprint(api_response)
 except ApiException as e:
     print("Exception when calling DefaultApi->visitors_visitor_id_get: %s\n" % e)
@@ -97,15 +98,12 @@ Class | Method | HTTP request | Description
 
 ## Documentation For Models
 
- - [BaseResponse](docs/BaseResponse.md)
  - [BrowserDetails](docs/BrowserDetails.md)
  - [Confidence](docs/Confidence.md)
  - [IPLocation](docs/IPLocation.md)
  - [IPLocationCity](docs/IPLocationCity.md)
  - [Location](docs/Location.md)
  - [ManyRequestsResponse](docs/ManyRequestsResponse.md)
- - [OneOfResponse](docs/OneOfResponse.md)
- - [PaginatedResponse](docs/PaginatedResponse.md)
  - [Response](docs/Response.md)
  - [StSeenAt](docs/StSeenAt.md)
  - [Subdivision](docs/Subdivision.md)

diff --git a/docs/BaseResponse.md b/docs/BaseResponse.md
diff --git a/docs/Confidence.md b/docs/Confidence.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**score** | **float** |  | 
+**score** | **float** | The confidence score is a floating-point number between 0 and 1 that represents the probability of accurate identification. | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/FingerprintApi.md b/docs/FingerprintApi.md
@@ -17,6 +17,7 @@ This endpoint allows you to get a history of visits with all available informati
 ```python
 from __future__ import print_function
 import swagger_client
+from swagger_client import Response
 from swagger_client.rest import ApiException
 from pprint import pprint
 
@@ -33,7 +34,7 @@ limit = 10  # int | Limit scanned results (optional)
 #before = 56  # int | Used to paginate results (optional)
 
 try:
-    api_response = api_instance.visitors_visitor_id_get(visitor_id, limit=limit)
+    api_response: Response = api_instance.get_visits(visitor_id, limit=2)
     pprint(api_response)
 except ApiException as e:
     print("Exception when calling DefaultApi->visitors_visitor_id_get: %s\n" % e)

diff --git a/docs/ManyRequestsResponse.md b/docs/ManyRequestsResponse.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**error** | **str** |  | 
+**error** | **str** | Error text. | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/OneOfResponse.md b/docs/OneOfResponse.md
diff --git a/docs/PaginatedResponse.md b/docs/PaginatedResponse.md
diff --git a/docs/Response.md b/docs/Response.md
@@ -3,6 +3,10 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**visitor_id** | **str** |  | 
+**visits** | [**list[Visit]**](Visit.md) |  | 
+**last_timestamp** | **int** | When more results are available (e.g., you scanned 200 results using &#x60;limit&#x60; parameter, but a total of 600 results are available), a special &#x60;lastTimestamp&#x60; top-level attribute is added to the response. If you want to paginate the results further in the past, you should use the value of this attribute. | [optional] 
+**pagination_key** | **str** | Visit&#x27;s &#x60;requestId&#x60; of the last visit in the current page. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/Visit.md b/docs/Visit.md
@@ -3,18 +3,18 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_id** | **str** |  | 
+**request_id** | **str** | Unique identifier of the user&#x27;s identification request. | 
 **browser_details** | [**BrowserDetails**](BrowserDetails.md) |  | 
-**incognito** | **bool** |  | 
+**incognito** | **bool** | Flag if user used incognito session. | 
 **ip** | **str** |  | 
 **ip_location** | [**IPLocation**](IPLocation.md) |  | 
-**timestamp** | **int** |  | 
-**time** | **datetime** |  | 
-**url** | **str** |  | 
-**tag** | **dict(str, object)** |  | 
-**linked_id** | **str** |  | [optional] 
+**timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. | 
+**time** | **datetime** | Time expressed according to ISO 8601 in UTC format. | 
+**url** | **str** | Page URL from which identification request was sent. | 
+**tag** | **dict(str, object)** | A customer-provided value or an object that was sent with identification request. | 
+**linked_id** | **str** | A customer-provided id that was sent with identification request. | [optional] 
 **confidence** | [**Confidence**](Confidence.md) |  | 
-**visitor_found** | **bool** |  | 
+**visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | 
 **first_seen_at** | **object** |  | 
 **last_seen_at** | **object** |  | 
 

diff --git a/docs/WebhookVisit.md b/docs/WebhookVisit.md
@@ -3,18 +3,18 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_id** | **str** |  | 
+**request_id** | **str** | Unique identifier of the user&#x27;s identification request. | 
 **browser_details** | [**BrowserDetails**](BrowserDetails.md) |  | 
-**incognito** | **bool** |  | 
+**incognito** | **bool** | Flag if user used incognito session. | 
 **ip** | **str** |  | 
 **ip_location** | [**IPLocation**](IPLocation.md) |  | 
-**timestamp** | **int** |  | 
-**time** | **datetime** |  | 
-**url** | **str** |  | 
-**tag** | **dict(str, object)** |  | 
-**linked_id** | **str** |  | [optional] 
+**timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. | 
+**time** | **datetime** | Time expressed according to ISO 8601 in UTC format. | 
+**url** | **str** | Page URL from which identification request was sent. | 
+**tag** | **dict(str, object)** | A customer-provided value or an object that was sent with identification request. | 
+**linked_id** | **str** | A customer-provided id that was sent with identification request. | [optional] 
 **confidence** | [**Confidence**](Confidence.md) |  | 
-**visitor_found** | **bool** |  | 
+**visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | 
 **first_seen_at** | **object** |  | 
 **last_seen_at** | **object** |  | 
 

diff --git a/run_checks.py b/run_checks.py
@@ -1,5 +1,6 @@
 from __future__ import print_function
 import swagger_client
+from swagger_client import Response
 from swagger_client.rest import ApiException
 from pprint import pprint
 import os
@@ -16,8 +17,8 @@
 # before = 56 # int | Used to paginate results (optional)
 
 try:
-    api_response = api_instance.get_visits(visitor_id, limit=2)
-    pprint(api_response['visitorId'])
+    api_response: Response = api_instance.get_visits(visitor_id, limit=2)
+    pprint(api_response.visitor_id)
 except ApiException as e:
     print("Exception when calling DefaultApi->visitors_visitor_id_get: %s\n" % e)
 

diff --git a/swagger_client/__init__.py b/swagger_client/__init__.py
@@ -20,15 +20,12 @@
 from swagger_client.api_client import ApiClient
 from swagger_client.configuration import Configuration
 # import models into sdk package
-from swagger_client.models.base_response import BaseResponse
 from swagger_client.models.browser_details import BrowserDetails
 from swagger_client.models.confidence import Confidence
 from swagger_client.models.ip_location import IPLocation
 from swagger_client.models.ip_location_city import IPLocationCity
 from swagger_client.models.location import Location
 from swagger_client.models.many_requests_response import ManyRequestsResponse
-from swagger_client.models.one_of_response import OneOfResponse
-from swagger_client.models.paginated_response import PaginatedResponse
 from swagger_client.models.response import Response
 from swagger_client.models.st_seen_at import StSeenAt
 from swagger_client.models.subdivision import Subdivision

diff --git a/swagger_client/models/__init__.py b/swagger_client/models/__init__.py
@@ -14,15 +14,12 @@
 from __future__ import absolute_import
 
 # import models into model package
-from swagger_client.models.base_response import BaseResponse
 from swagger_client.models.browser_details import BrowserDetails
 from swagger_client.models.confidence import Confidence
 from swagger_client.models.ip_location import IPLocation
 from swagger_client.models.ip_location_city import IPLocationCity
 from swagger_client.models.location import Location
 from swagger_client.models.many_requests_response import ManyRequestsResponse
-from swagger_client.models.one_of_response import OneOfResponse
-from swagger_client.models.paginated_response import PaginatedResponse
 from swagger_client.models.response import Response
 from swagger_client.models.st_seen_at import StSeenAt
 from swagger_client.models.subdivision import Subdivision

diff --git a/swagger_client/models/base_response.py b/swagger_client/models/base_response.py
diff --git a/swagger_client/models/confidence.py b/swagger_client/models/confidence.py
@@ -45,6 +45,7 @@ def __init__(self, score=None):  # noqa: E501
     def score(self):
         """Gets the score of this Confidence.  # noqa: E501
 
+        The confidence score is a floating-point number between 0 and 1 that represents the probability of accurate identification.  # noqa: E501
 
         :return: The score of this Confidence.  # noqa: E501
         :rtype: float
@@ -55,6 +56,7 @@ def score(self):
     def score(self, score):
         """Sets the score of this Confidence.
 
+        The confidence score is a floating-point number between 0 and 1 that represents the probability of accurate identification.  # noqa: E501
 
         :param score: The score of this Confidence.  # noqa: E501
         :type: float

diff --git a/swagger_client/models/many_requests_response.py b/swagger_client/models/many_requests_response.py
@@ -45,6 +45,7 @@ def __init__(self, error=None):  # noqa: E501
     def error(self):
         """Gets the error of this ManyRequestsResponse.  # noqa: E501
 
+        Error text.  # noqa: E501
 
         :return: The error of this ManyRequestsResponse.  # noqa: E501
         :rtype: str
@@ -55,6 +56,7 @@ def error(self):
     def error(self, error):
         """Sets the error of this ManyRequestsResponse.
 
+        Error text.  # noqa: E501
 
         :param error: The error of this ManyRequestsResponse.  # noqa: E501
         :type: str