Deploying from URLR/api-clients-generation@90a7908a

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [2.0.1] - 2024-05-29
+
+- Documentation fixes
+
 ## [2.0.0] - 2024-05-29
 
 - Updated URLR API version to 1.0

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.0
-- Package version: 2.0.0
+- Package version: 2.0.1
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
 For more information, please visit [https://urlr.me/en](https://urlr.me/en)

docs/AccessTokensApi.md

@@ -34,7 +34,7 @@ configuration = urlr.Configuration(
 with urlr.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = urlr.AccessTokensApi(api_client)
-    create_access_token_request = urlr.CreateAccessTokenRequest() # CreateAccessTokenRequest | Your credentials (optional)
+    create_access_token_request = urlr.CreateAccessTokenRequest() # CreateAccessTokenRequest | You can use this endpoint to get an access token to access the API. (optional)
 
     try:
         # Get an access token
@@ -52,7 +52,7 @@ with urlr.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **create_access_token_request** | [**CreateAccessTokenRequest**](CreateAccessTokenRequest.md)| Your credentials | [optional] 
+ **create_access_token_request** | [**CreateAccessTokenRequest**](CreateAccessTokenRequest.md)| You can use this endpoint to get an access token to access the API. | [optional] 
 
 ### Return type
 
@@ -102,7 +102,7 @@ configuration = urlr.Configuration(
 with urlr.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = urlr.AccessTokensApi(api_client)
-    refresh_access_token_request = urlr.RefreshAccessTokenRequest() # RefreshAccessTokenRequest | Your credentials (optional)
+    refresh_access_token_request = urlr.RefreshAccessTokenRequest() # RefreshAccessTokenRequest | You can use this endpoint to refresh your access token without credentials. (optional)
 
     try:
         # Refresh an access token
@@ -120,7 +120,7 @@ with urlr.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **refresh_access_token_request** | [**RefreshAccessTokenRequest**](RefreshAccessTokenRequest.md)| Your credentials | [optional] 
+ **refresh_access_token_request** | [**RefreshAccessTokenRequest**](RefreshAccessTokenRequest.md)| You can use this endpoint to refresh your access token without credentials. | [optional] 
 
 ### Return type
 

docs/CreateLink201Response.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **url** | **str** | Original URL | [optional] 
 **team** | **str** | Team API ID | [optional] 
 **folder_id** | **str** | Folder API ID | [optional] 
-**domain_id** | **str** | Domain | [optional] 
+**domain** | **str** | Domain | [optional] 
 **code** | **str** | Short code | [optional] 
 **label** | **str** | Label | [optional] 
 **created_at** | **datetime** | Creation date | [optional] 

docs/GetStatisticsRequest.md

@@ -6,8 +6,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **link_id** | **str** | Link API ID | [optional] 
-**var_from** | **datetime** | Get stats from this date | [optional] 
-**to** | **datetime** | Get stats until this date | [optional] 
+**var_from** | **datetime** | Get statistics from this date | [optional] 
+**to** | **datetime** | Get statistics until this date | [optional] 
 **include_bots** | **bool** | Whether include bots or not in statistics | [optional] [default to False]
 
 ## Example

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "urlr"
-version = "2.0.0"
+version = "2.0.1"
 description = "Python client for URLR"
 authors = ["URLR <[email protected]>"]
 license = "MIT"

setup.py

@@ -22,7 +22,7 @@
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "urlr"
-VERSION = "2.0.0"
+VERSION = "2.0.1"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",

test/test_create_link201_response.py

@@ -40,7 +40,7 @@ def make_instance(self, include_optional) -> CreateLink201Response:
                 url = '',
                 team = '',
                 folder_id = '',
-                domain_id = 'urlr.me',
+                domain = 'urlr.me',
                 code = 'xxxxx',
                 label = '',
                 created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),

urlr/__init__.py

@@ -15,7 +15,7 @@
 """  # noqa: E501
 
 
-__version__ = "2.0.0"
+__version__ = "2.0.1"
 
 # import apis into sdk package
 from urlr.api.access_tokens_api import AccessTokensApi

urlr/api/access_tokens_api.py

@@ -45,7 +45,7 @@ def __init__(self, api_client=None) -> None:
     @validate_call
     def create_access_token(
         self,
-        create_access_token_request: Annotated[Optional[CreateAccessTokenRequest], Field(description="Your credentials")] = None,
+        create_access_token_request: Annotated[Optional[CreateAccessTokenRequest], Field(description="You can use this endpoint to get an access token to access the API.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -62,7 +62,7 @@ def create_access_token(
         """Get an access token
 
 
-        :param create_access_token_request: Your credentials
+        :param create_access_token_request: You can use this endpoint to get an access token to access the API.
         :type create_access_token_request: CreateAccessTokenRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -112,7 +112,7 @@ def create_access_token(
     @validate_call
     def create_access_token_with_http_info(
         self,
-        create_access_token_request: Annotated[Optional[CreateAccessTokenRequest], Field(description="Your credentials")] = None,
+        create_access_token_request: Annotated[Optional[CreateAccessTokenRequest], Field(description="You can use this endpoint to get an access token to access the API.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -129,7 +129,7 @@ def create_access_token_with_http_info(
         """Get an access token
 
 
-        :param create_access_token_request: Your credentials
+        :param create_access_token_request: You can use this endpoint to get an access token to access the API.
         :type create_access_token_request: CreateAccessTokenRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -179,7 +179,7 @@ def create_access_token_with_http_info(
     @validate_call
     def create_access_token_without_preload_content(
         self,
-        create_access_token_request: Annotated[Optional[CreateAccessTokenRequest], Field(description="Your credentials")] = None,
+        create_access_token_request: Annotated[Optional[CreateAccessTokenRequest], Field(description="You can use this endpoint to get an access token to access the API.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -196,7 +196,7 @@ def create_access_token_without_preload_content(
         """Get an access token
 
 
-        :param create_access_token_request: Your credentials
+        :param create_access_token_request: You can use this endpoint to get an access token to access the API.
         :type create_access_token_request: CreateAccessTokenRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -315,7 +315,7 @@ def _create_access_token_serialize(
     @validate_call
     def refresh_access_token(
         self,
-        refresh_access_token_request: Annotated[Optional[RefreshAccessTokenRequest], Field(description="Your credentials")] = None,
+        refresh_access_token_request: Annotated[Optional[RefreshAccessTokenRequest], Field(description="You can use this endpoint to refresh your access token without credentials.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -332,7 +332,7 @@ def refresh_access_token(
         """Refresh an access token
 
 
-        :param refresh_access_token_request: Your credentials
+        :param refresh_access_token_request: You can use this endpoint to refresh your access token without credentials.
         :type refresh_access_token_request: RefreshAccessTokenRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -382,7 +382,7 @@ def refresh_access_token(
     @validate_call
     def refresh_access_token_with_http_info(
         self,
-        refresh_access_token_request: Annotated[Optional[RefreshAccessTokenRequest], Field(description="Your credentials")] = None,
+        refresh_access_token_request: Annotated[Optional[RefreshAccessTokenRequest], Field(description="You can use this endpoint to refresh your access token without credentials.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -399,7 +399,7 @@ def refresh_access_token_with_http_info(
         """Refresh an access token
 
 
-        :param refresh_access_token_request: Your credentials
+        :param refresh_access_token_request: You can use this endpoint to refresh your access token without credentials.
         :type refresh_access_token_request: RefreshAccessTokenRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -449,7 +449,7 @@ def refresh_access_token_with_http_info(
     @validate_call
     def refresh_access_token_without_preload_content(
         self,
-        refresh_access_token_request: Annotated[Optional[RefreshAccessTokenRequest], Field(description="Your credentials")] = None,
+        refresh_access_token_request: Annotated[Optional[RefreshAccessTokenRequest], Field(description="You can use this endpoint to refresh your access token without credentials.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -466,7 +466,7 @@ def refresh_access_token_without_preload_content(
         """Refresh an access token
 
 
-        :param refresh_access_token_request: Your credentials
+        :param refresh_access_token_request: You can use this endpoint to refresh your access token without credentials.
         :type refresh_access_token_request: RefreshAccessTokenRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request

urlr/api_client.py

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

urlr/configuration.py

@@ -380,7 +380,7 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0\n"\
-               "SDK Package Version: 2.0.0".\
+               "SDK Package Version: 2.0.1".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

urlr/models/create_link201_response.py

@@ -32,13 +32,13 @@ class CreateLink201Response(BaseModel):
     url: Optional[StrictStr] = Field(default=None, description="Original URL")
     team: Optional[StrictStr] = Field(default=None, description="Team API ID")
     folder_id: Optional[StrictStr] = Field(default=None, description="Folder API ID")
-    domain_id: Optional[StrictStr] = Field(default=None, description="Domain")
+    domain: Optional[StrictStr] = Field(default=None, description="Domain")
     code: Optional[StrictStr] = Field(default=None, description="Short code")
     label: Optional[StrictStr] = Field(default=None, description="Label")
     created_at: Optional[datetime] = Field(default=None, description="Creation date")
     updated_at: Optional[datetime] = Field(default=None, description="Modification date")
     expired_at: Optional[datetime] = Field(default=None, description="Expiration date")
-    __properties: ClassVar[List[str]] = ["id", "url", "team", "folder_id", "domain_id", "code", "label", "created_at", "updated_at", "expired_at"]
+    __properties: ClassVar[List[str]] = ["id", "url", "team", "folder_id", "domain", "code", "label", "created_at", "updated_at", "expired_at"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -95,7 +95,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "url": obj.get("url"),
             "team": obj.get("team"),
             "folder_id": obj.get("folder_id"),
-            "domain_id": obj.get("domain_id"),
+            "domain": obj.get("domain"),
             "code": obj.get("code"),
             "label": obj.get("label"),
             "created_at": obj.get("created_at"),

urlr/models/get_statistics_request.py

@@ -29,8 +29,8 @@ class GetStatisticsRequest(BaseModel):
     GetStatisticsRequest
     """ # noqa: E501
     link_id: Optional[StrictStr] = Field(default=None, description="Link API ID")
-    var_from: Optional[datetime] = Field(default=None, description="Get stats from this date", alias="from")
-    to: Optional[datetime] = Field(default=None, description="Get stats until this date")
+    var_from: Optional[datetime] = Field(default=None, description="Get statistics from this date", alias="from")
+    to: Optional[datetime] = Field(default=None, description="Get statistics until this date")
     include_bots: Optional[StrictBool] = Field(default=False, description="Whether include bots or not in statistics")
     __properties: ClassVar[List[str]] = ["link_id", "from", "to", "include_bots"]