Deploying from URLR/api-clients-generation@84fbe440

Author: Huluti

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## [2.11.1] - 2025-08-07
+- Better documentation and examples.
+
 ## [2.11.0] - 2025-08-07
 
 ### Changed

README.md

@@ -1,11 +1,11 @@
-# [email protected].0
+# [email protected].1
 
 ![PyPI - Version](https://img.shields.io/pypi/v/urlr) ![PyPI - Downloads](https://img.shields.io/pypi/dm/urlr) ![PyPI - License](https://img.shields.io/pypi/l/urlr)
 
 This SDK is automatically generated with the [OpenAPI Generator](https://openapi-generator.tech) project.
 
 - API version: 1.10
-- Package version: 2.11.0
+- Package version: 2.11.1
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
 For more information, please visit [https://urlr.me/en](https://urlr.me/en)
@@ -50,39 +50,50 @@ Execute `pytest` to run the tests.
 Please follow the [installation procedure](#installation--usage) and then run the following:
 
 ```python
+import os
 import urlr
 from urlr.rest import ApiException
-from pprint import pprint
+
+username = os.getenv("URLR_API_USERNAME")  # to be defined on your side
+password = os.getenv("URLR_API_PASSWORD")  # to be defined on your side
+
 
 # Access Tokens
 
-with urlr.ApiClient() as api_client:
-    access_tokens_api = urlr.AccessTokensApi(api_client)
-    
-    access_tokens_request = urlr.AccessTokensRequest.from_json('{"username": "","password": ""}')
+configuration = urlr.Configuration()
+
+with urlr.ApiClient(configuration) as api_client:
+    access_token_api = urlr.AccessTokensApi(api_client)
+
+    create_access_token_request = urlr.CreateAccessTokenRequest(
+        username=username,
+        password=password,
+    )
 
     try:
-        api_response = access_tokens_api.create_access_token(access_tokens_request=access_tokens_request)
+        api_response = access_token_api.create_access_token(
+            create_access_token_request=create_access_token_request)
     except ApiException as e:
         print("Exception when calling AccessTokensApi->create_access_token: %s\n" % e)
         quit()
 
-# Link shortening
+configuration.access_token = api_response.token
 
-configuration = urlr.Configuration(
-    access_token = api_response.token
-)
+# Create a link
 
 with urlr.ApiClient(configuration) as api_client:
-    link_api = urlr.LinksApi(api_client)
-    create_link_request = urlr.CreateLinkRequest.from_json('{"url": "","team_id": ""}')
+    links_api = urlr.LinksApi(api_client)
+    create_link_request = urlr.CreateLinkRequest(
+        url="",
+        team_id=""
+    )
 
     try:
-        # Create a link
-        api_response = link_api.create_link(create_link_request=create_link_request)
-        print(api_response)
+        link = links_api.create_link(
+            create_link_request=create_link_request)
     except Exception as e:
         print("Exception when calling LinksApi->create_link: %s\n" % e)
+
 ```
 
 A complete example is [available here](examples/example1.py).

examples/example1.py

@@ -1,44 +1,66 @@
+import os
 import urlr
 from urlr.rest import ApiException
-from pprint import pprint
+
+username = os.getenv("URLR_API_USERNAME")  # to define on your end
+password = os.getenv("URLR_API_PASSWORD")  # to define on your end
+
 
 # Access Tokens
 
-with urlr.ApiClient() as api_client:
-    access_tokens_api = urlr.AccessTokensApi(api_client)
-    
-    access_tokens_request = urlr.AccessTokensRequest.from_json('{"username": "","password": ""}')
+configuration = urlr.Configuration()
+
+with urlr.ApiClient(configuration) as api_client:
+    access_token_api = urlr.AccessTokensApi(api_client)
+
+    create_access_token_request = urlr.CreateAccessTokenRequest(
+        username=username,
+        password=password,
+    )
 
     try:
-        api_response = access_tokens_api.create_access_token(access_tokens_request=access_tokens_request)
+        api_response = access_token_api.create_access_token(
+            create_access_token_request=create_access_token_request)
     except ApiException as e:
         print("Exception when calling AccessTokensApi->create_access_token: %s\n" % e)
         quit()
 
-# Link shortening
+configuration.access_token = api_response.token
+
+# Workspaces - get workspace id
+
+with urlr.ApiClient(configuration) as api_client:
+    workspaces_api = urlr.WorkspacesApi(api_client)
+    try:
+        workspaces = workspaces_api.get_teams()
+        workspace_id = workspaces.teams[0].id
+    except Exception as e:
+        print("Exception when calling WorkspacesApi->get_teams: %s\n" % e)
 
-configuration = urlr.Configuration(
-    access_token = api_response.token
-)
+# Create a link
 
 with urlr.ApiClient(configuration) as api_client:
-    link_api = urlr.LinksApi(api_client)
-    create_link_request = urlr.CreateLinkRequest.from_json('{"url": "","team_id": ""}')
+    links_api = urlr.LinksApi(api_client)
+    create_link_request = urlr.CreateLinkRequest(
+        url="https://github.com/URLR",
+        team_id=workspace_id
+    )
 
     try:
-        api_response = link_api.create_link(create_link_request=create_link_request)
-        pprint(api_response)
+        link = links_api.create_link(
+            create_link_request=create_link_request)
     except Exception as e:
-        pprint("Exception when calling LinksApi->create_link: %s\n" % e)
+        print("Exception when calling LinksApi->create_link: %s\n" % e)
 
-# Statistics
+# Get statistics
 
 with urlr.ApiClient(configuration) as api_client:
     statistics_api = urlr.StatisticsApi(api_client)
-    statistics_request = urlr.StatisticsRequest.from_json('{"link_id": ""}')
+    get_statistics_request = urlr.GetStatisticsRequest(link_id=link.id)
 
     try:
-        api_response = statistics_api.get_statistics(statistics_request=statistics_request)
-        pprint(api_response)
+        api_response = statistics_api.get_statistics(
+            get_statistics_request=get_statistics_request)
+        print(api_response)
     except Exception as e:
-        print("Exception when calling StatisticsApi->get_statistics: %s\n" % e)
+        print("Exception when calling StatisticsApi->get_statistics: %s\n" % e)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "urlr"
-version = "2.11.0"
+version = "2.11.1"
 description = "Python client for URLR"
 authors = [
   {name = "URLR",email = "[email protected]"},

setup.py

@@ -22,7 +22,7 @@
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "urlr"
-VERSION = "2.11.0"
+VERSION = "2.11.1"
 PYTHON_REQUIRES = ">= 3.9"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",

urlr/__init__.py

@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "2.11.0"
+__version__ = "2.11.1"
 
 # Define package exports
 __all__ = [

urlr/api_client.py

@@ -91,7 +91,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/2.11.0/python'
+        self.user_agent = 'OpenAPI-Generator/2.11.1/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

urlr/configuration.py

@@ -512,7 +512,7 @@ def to_debug_report(self) -> str:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.10\n"\
-               "SDK Package Version: 2.11.0".\
+               "SDK Package Version: 2.11.1".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]: