Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Huluti committed May 29, 2024
1 parent 7341795 commit 893a0db
Show file tree
Hide file tree
Showing 122 changed files with 4,326 additions and 2,652 deletions.
129 changes: 72 additions & 57 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -2,76 +2,91 @@
.gitignore
.gitlab-ci.yml
README.md
docs/Authentification200Response.md
docs/Authentification401Response.md
docs/AuthentificationApi.md
docs/AuthentificationRequest.md
docs/Folder200Response.md
docs/Folder200ResponseFoldersInner.md
docs/FolderApi.md
docs/FolderRequest.md
docs/LinkApi.md
docs/ReduceLink200Response.md
docs/ReduceLink400Response.md
docs/ReduceLinkRequest.md
docs/Stats200Response.md
docs/Stats400Response.md
docs/StatsApi.md
docs/StatsRequest.md
docs/Team200Response.md
docs/Team200ResponseTeamsInner.md
docs/TeamApi.md
docs/AccessTokensApi.md
docs/CreateAccessToken200Response.md
docs/CreateAccessToken401Response.md
docs/CreateAccessTokenRequest.md
docs/CreateLink201Response.md
docs/CreateLink429Response.md
docs/CreateLink500Response.md
docs/CreateLinkRequest.md
docs/FoldersApi.md
docs/GetFolders200Response.md
docs/GetFolders200ResponseFoldersInner.md
docs/GetLink200Response.md
docs/GetLink401Response.md
docs/GetLink404Response.md
docs/GetLink422Response.md
docs/GetStatistics200Response.md
docs/GetStatisticsRequest.md
docs/GetTeams200Response.md
docs/GetTeams200ResponseTeamsInner.md
docs/LinksApi.md
docs/RefreshAccessToken401Response.md
docs/RefreshAccessTokenRequest.md
docs/StatisticsApi.md
docs/TeamsApi.md
pyproject.toml
requirements.txt
setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_authentification200_response.py
test/test_authentification401_response.py
test/test_authentification_api.py
test/test_authentification_request.py
test/test_folder200_response.py
test/test_folder200_response_folders_inner.py
test/test_folder_api.py
test/test_folder_request.py
test/test_link_api.py
test/test_reduce_link200_response.py
test/test_reduce_link400_response.py
test/test_reduce_link_request.py
test/test_stats200_response.py
test/test_stats400_response.py
test/test_stats_api.py
test/test_stats_request.py
test/test_team200_response.py
test/test_team200_response_teams_inner.py
test/test_team_api.py
test/test_access_tokens_api.py
test/test_create_access_token200_response.py
test/test_create_access_token401_response.py
test/test_create_access_token_request.py
test/test_create_link201_response.py
test/test_create_link429_response.py
test/test_create_link500_response.py
test/test_create_link_request.py
test/test_folders_api.py
test/test_get_folders200_response.py
test/test_get_folders200_response_folders_inner.py
test/test_get_link200_response.py
test/test_get_link401_response.py
test/test_get_link404_response.py
test/test_get_link422_response.py
test/test_get_statistics200_response.py
test/test_get_statistics_request.py
test/test_get_teams200_response.py
test/test_get_teams200_response_teams_inner.py
test/test_links_api.py
test/test_refresh_access_token401_response.py
test/test_refresh_access_token_request.py
test/test_statistics_api.py
test/test_teams_api.py
tox.ini
urlr/__init__.py
urlr/api/__init__.py
urlr/api/authentification_api.py
urlr/api/folder_api.py
urlr/api/link_api.py
urlr/api/stats_api.py
urlr/api/team_api.py
urlr/api/access_tokens_api.py
urlr/api/folders_api.py
urlr/api/links_api.py
urlr/api/statistics_api.py
urlr/api/teams_api.py
urlr/api_client.py
urlr/api_response.py
urlr/configuration.py
urlr/exceptions.py
urlr/models/__init__.py
urlr/models/authentification200_response.py
urlr/models/authentification401_response.py
urlr/models/authentification_request.py
urlr/models/folder200_response.py
urlr/models/folder200_response_folders_inner.py
urlr/models/folder_request.py
urlr/models/reduce_link200_response.py
urlr/models/reduce_link400_response.py
urlr/models/reduce_link_request.py
urlr/models/stats200_response.py
urlr/models/stats400_response.py
urlr/models/stats_request.py
urlr/models/team200_response.py
urlr/models/team200_response_teams_inner.py
urlr/models/create_access_token200_response.py
urlr/models/create_access_token401_response.py
urlr/models/create_access_token_request.py
urlr/models/create_link201_response.py
urlr/models/create_link429_response.py
urlr/models/create_link500_response.py
urlr/models/create_link_request.py
urlr/models/get_folders200_response.py
urlr/models/get_folders200_response_folders_inner.py
urlr/models/get_link200_response.py
urlr/models/get_link401_response.py
urlr/models/get_link404_response.py
urlr/models/get_link422_response.py
urlr/models/get_statistics200_response.py
urlr/models/get_statistics_request.py
urlr/models/get_teams200_response.py
urlr/models/get_teams200_response_teams_inner.py
urlr/models/refresh_access_token401_response.py
urlr/models/refresh_access_token_request.py
urlr/py.typed
urlr/rest.py
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.5.0
7.6.0
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## [2.0.0] - 2024-05-29

- Updated URLR API version to 1.0
- Updated to OpenAPI Generator 7.6.0

## [1.2.0] - 2024-04-02

- Updated URLR API version to 0.4
Expand Down
53 changes: 30 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# urlr@1.2.0
# urlr@2.0.0

![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: 0.3
- Package version: 1.2.0
- API version: 1.0
- Package version: 2.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit [https://urlr.me/en](https://urlr.me/en)
Expand Down Expand Up @@ -89,33 +89,40 @@ A complete example is [available here](examples/example1.py).

## API Endpoints

All URIs are relative to *https://urlr.me/api*
All URIs are relative to *https://urlr.me/api/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuthentificationApi* | [**authentification**](docs/AuthentificationApi.md#authentification) | **POST** /login_check | Get an access token
*FolderApi* | [**folder**](docs/FolderApi.md#folder) | **GET** /folder | Get folders of team
*LinkApi* | [**reduce_link**](docs/LinkApi.md#reduce_link) | **POST** /reduce-link | Shorten a link
*StatsApi* | [**stats**](docs/StatsApi.md#stats) | **POST** /stats | Get statistics of a link
*TeamApi* | [**team**](docs/TeamApi.md#team) | **GET** /team | Get teams of user
*AccessTokensApi* | [**create_access_token**](docs/AccessTokensApi.md#create_access_token) | **POST** /access_tokens/create | Get an access token
*AccessTokensApi* | [**refresh_access_token**](docs/AccessTokensApi.md#refresh_access_token) | **POST** /access_tokens/refresh | Refresh an access token
*FoldersApi* | [**get_folders**](docs/FoldersApi.md#get_folders) | **GET** /folders/{team_id} | Get folders of team
*LinksApi* | [**create_link**](docs/LinksApi.md#create_link) | **POST** /links/create | Create a link
*LinksApi* | [**get_link**](docs/LinksApi.md#get_link) | **GET** /links/{link_id} | Get a link
*StatisticsApi* | [**get_statistics**](docs/StatisticsApi.md#get_statistics) | **POST** /statistics | Get statistics of a link
*TeamsApi* | [**get_teams**](docs/TeamsApi.md#get_teams) | **GET** /teams | Get teams of user


## Models

- [Authentification200Response](docs/Authentification200Response.md)
- [Authentification401Response](docs/Authentification401Response.md)
- [AuthentificationRequest](docs/AuthentificationRequest.md)
- [Folder200Response](docs/Folder200Response.md)
- [Folder200ResponseFoldersInner](docs/Folder200ResponseFoldersInner.md)
- [FolderRequest](docs/FolderRequest.md)
- [ReduceLink200Response](docs/ReduceLink200Response.md)
- [ReduceLink400Response](docs/ReduceLink400Response.md)
- [ReduceLinkRequest](docs/ReduceLinkRequest.md)
- [Stats200Response](docs/Stats200Response.md)
- [Stats400Response](docs/Stats400Response.md)
- [StatsRequest](docs/StatsRequest.md)
- [Team200Response](docs/Team200Response.md)
- [Team200ResponseTeamsInner](docs/Team200ResponseTeamsInner.md)
- [CreateAccessToken200Response](docs/CreateAccessToken200Response.md)
- [CreateAccessToken401Response](docs/CreateAccessToken401Response.md)
- [CreateAccessTokenRequest](docs/CreateAccessTokenRequest.md)
- [CreateLink201Response](docs/CreateLink201Response.md)
- [CreateLink429Response](docs/CreateLink429Response.md)
- [CreateLink500Response](docs/CreateLink500Response.md)
- [CreateLinkRequest](docs/CreateLinkRequest.md)
- [GetFolders200Response](docs/GetFolders200Response.md)
- [GetFolders200ResponseFoldersInner](docs/GetFolders200ResponseFoldersInner.md)
- [GetLink200Response](docs/GetLink200Response.md)
- [GetLink401Response](docs/GetLink401Response.md)
- [GetLink404Response](docs/GetLink404Response.md)
- [GetLink422Response](docs/GetLink422Response.md)
- [GetStatistics200Response](docs/GetStatistics200Response.md)
- [GetStatisticsRequest](docs/GetStatisticsRequest.md)
- [GetTeams200Response](docs/GetTeams200Response.md)
- [GetTeams200ResponseTeamsInner](docs/GetTeams200ResponseTeamsInner.md)
- [RefreshAccessToken401Response](docs/RefreshAccessToken401Response.md)
- [RefreshAccessTokenRequest](docs/RefreshAccessTokenRequest.md)


<a id="documentation-for-authorization"></a>
Expand Down
146 changes: 146 additions & 0 deletions docs/AccessTokensApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# urlr.AccessTokensApi

All URIs are relative to *https://urlr.me/api/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_access_token**](AccessTokensApi.md#create_access_token) | **POST** /access_tokens/create | Get an access token
[**refresh_access_token**](AccessTokensApi.md#refresh_access_token) | **POST** /access_tokens/refresh | Refresh an access token


# **create_access_token**
> CreateAccessToken200Response create_access_token(create_access_token_request=create_access_token_request)
Get an access token

### Example


```python
import urlr
from urlr.models.create_access_token200_response import CreateAccessToken200Response
from urlr.models.create_access_token_request import CreateAccessTokenRequest
from urlr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://urlr.me/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = urlr.Configuration(
host = "https://urlr.me/api/v1"
)


# Enter a context with an instance of the API client
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)

try:
# Get an access token
api_response = api_instance.create_access_token(create_access_token_request=create_access_token_request)
print("The response of AccessTokensApi->create_access_token:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AccessTokensApi->create_access_token: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**create_access_token_request** | [**CreateAccessTokenRequest**](CreateAccessTokenRequest.md)| Your credentials | [optional]

### Return type

[**CreateAccessToken200Response**](CreateAccessToken200Response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Access token | - |
**401** | Error | - |

[[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)

# **refresh_access_token**
> CreateAccessToken200Response refresh_access_token(refresh_access_token_request=refresh_access_token_request)
Refresh an access token

### Example


```python
import urlr
from urlr.models.create_access_token200_response import CreateAccessToken200Response
from urlr.models.refresh_access_token_request import RefreshAccessTokenRequest
from urlr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://urlr.me/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = urlr.Configuration(
host = "https://urlr.me/api/v1"
)


# Enter a context with an instance of the API client
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)

try:
# Refresh an access token
api_response = api_instance.refresh_access_token(refresh_access_token_request=refresh_access_token_request)
print("The response of AccessTokensApi->refresh_access_token:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AccessTokensApi->refresh_access_token: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**refresh_access_token_request** | [**RefreshAccessTokenRequest**](RefreshAccessTokenRequest.md)| Your credentials | [optional]

### Return type

[**CreateAccessToken200Response**](CreateAccessToken200Response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Refreshed access token | - |
**401** | Error | - |

[[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)

Loading

0 comments on commit 893a0db

Please sign in to comment.